メインコンテンツまでスキップ

JSのライブラリの使用

  1. 内蔵の JSライブラリ

Apidogでrequire経由でJSライブラリを使用できます。

var cryptoJs = require("crypto-js");
console.log(cryptoJs.SHA256("Message"));
  1. 非内蔵のJSライブラリ

$$.liveRequire経由で、非内蔵だが、npmでリリースされた様々なライブラリを動的に導入できます。(単純のJSライブラリにのみ対応します。ブラウザ対応が明記されるライブラリが一番望ましいもので、C/C++などの言語拡張を含むライブラリをロードする時、タイムアウトなど異常のエラーが発生する可能性があります)

ご注意:

内蔵以外のライブラリについては、ネットワークからJSライブラリをダウンロードする必要があるので、インターネットに接続する必要があります。それは、パフォーマンスの低下問題にも繋がりますので、内蔵のJSライブラリを優先して使用することをお勧めします。

// Below is an example of using a non-built-in JS class library.

// Get a single npm library: camelcase
$$.liveRequire("camelcase", (camelCase) => {
camelCase("foo-bar"); // => 'fooBar'
});

//Get a multiple npm libraries: camelcase
$$.liveRequire(["camelcase", "md5"], (camelCase, md5) => {
camelCase("foo-bar"); // => 'fooBar'
md5("message"); // => '78e731027d8fd50ed642340b7c9a63b3'
});

Built-in library list

  • エンコードとデコード
    • atob(v2.1.2): Base64デコード。
    • btoa(v1.2.1): Base64エンコード。
    • crypto-js(v3.1.9-1): 一般的なエンコードおよびデコード方法(Base64、MD5、SHA、HMAC、AESなど)を含むエンコード/デコードライブラリ。
      • ライブラリのサブモジュールではなく、モジュール全体のみをRequireできます。詳細については、こちらのドキュメントをご覧ください。
    • jsrsasign(10.3.0): RSA 暗号化/復号化。Apidog 1.45 以上のバージョンでのみ利用可能。
  • アサーション
    • chai (v4.2.0): BDD / TDDアサーションライブラリ。
  • Tools
    • postman-collection(v3.4.0): Postman Collectionライブラリ。
    • cheerio(v0.22.0): jQueryのサブセット。
    • lodash (v4.17.11):JSユーティリティライブラリ。
    • moment(v2.22.2): 日付ライブラリ(Localesは含まない)。
    • uuid: UUIDの生成。
    • xml2js(v0.4.19): XMLをJSONに変換する。
    • csv-parse/lib/sync( v1.2.4): CSVの解析。
  • JSONSchemaのバリデーション
    • tv4(v1.3.0):JSONSchemaのバリデーション。
    • ajv(v6.6.2):JSONSchemaのバリデーション。
  • 内蔵のNodeJSモジュール

使い方

使用する前に、相応のモジュールに変数を割り当てます。

// SHA256
var cryptoJs = require("crypto-js");
console.log(cryptoJs.SHA256("Message"));

// base64
var atob = require("atob");
console.log(atob("Message"));
ご注意:

内蔵ライブラリを使用する場合にのみ、モジュール全体をRequireすることができます。単にサブモジュールをRequireすることはできません。

// A correct example.
var cryptoJs = require("crypto-js");
console.log(cryptoJs.SHA256("Message"));

// A wrong example.
var SHA256 = require("crypto-js/sha256");
console.log(SHA256("Message"));