使用 JS 类库

# 使用 JS 类库

  1. 内置的 JS 类库

    通过 require方法可以直接使用 Apifox 内置的 JS 类库。

    var cryptoJs = require("crypto-js");
    console.log(cryptoJs.SHA256("Message"));
    
  2. 非内置的 JS 类库

    通过fox.liveRequire方法可以动态引入未内置的但是在 npm 上已发布的其他各种库(仅支持纯 js 库,最好是写明了支持浏览器端运行的 browser 字样的库,含 C/C++等语言扩展之类的库是不支持加载的,会运行超时或异常)。

    注意:

    1. 仅 Apifox 版本号 >= 1.4.5 才支持,老版本不支持,请升级到最新版。
    2. 非内置库需要动态从网络下载 JS 类库,所以必须要联网,且性能有有所损耗,建议优先使用内置的 JS 库。
    // 使用非内置的 JS 类库示例
    
    // 引入单个 npm 库:camelcase
    fox.liveRequire("camelcase", (camelCase) => {
      camelCase("foo-bar"); // => 'fooBar'
    });
    
    // 引入多个 npm 库:camelcase,
    fox.liveRequire(["camelcase", "md5"], (camelCase, md5) => {
      camelCase("foo-bar"); // => 'fooBar'
      md5("message"); // => '78e731027d8fd50ed642340b7c9a63b3'
    });
    

# 内置类库列表

  • Encode、Decode 库
    • atob(v2.1.2):Base64 解码
    • btoa(v1.2.1):Base64 编码
    • crypto-js(v3.1.9-1):编码 / 解码库,常用的编码解码方式基本都有,如 Base64、MD5、SHA、HMAC、AES 等等。
      • 注意:只能 require 整个模块,不能单独 require 类库里的某个子模块,具体看本文档末尾说明。
    • jsrsasign(10.3.0):RSA 加密 / 解密 (Apifox 版本号 >= 1.4.5 才支持,老版本不支持)
  • 断言
    • chai (v4.2.0):BDD / TDD 断言库
  • 实用工具
  • JSONSchema 校验库
    • tv4(v1.3.0):JSONSchema 校验库
    • ajv(v6.6.2):JSONSchema 校验库
  • 内置 NodeJS 模块

# 使用方式

require 对应模块,赋值给一个变量即可使用。

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

// base64
var atob = require("atob");
console.log(atob("Message"));

注意

使用内置类库时,只能 require 整个模块,不能单独 require 类库里的某个子模块

// 正确示例:
var cryptoJs = require("crypto-js");
console.log(cryptoJs.SHA256("Message"));

// 错误示例
var SHA256 = require("crypto-js/sha256");
console.log(SHA256("Message"));

::