跳到主要内容

Code generator library

你可以在 Postman 中为 API 集合生成客户端代码。Postman 的 Node.js 代码生成器模块结合 Collection SDK 将请求转换为目标语言的客户端代码。

代码生成器采用 Collection SDK Request 对象 并将其转换为代码，以使用指定的语言和框架在客户端应用程序中发出相同的请求。

你可以从 npm 安装代码生成器库，也可以 从其 repo 克隆它 。

要开始使用代码生成器模块， 请查看 GitHub 上项目存储库中的安装和使用说明 。

你还可以在 Postman 中 为请求或集合生成客户端代码。

以编程方式使用代码生成​

以下简化的代码摘录演示了如何使用convertCollection SDK 从 Request 对象构建客户端代码片段，目标是 Node.js：

var codegen = require('postman-code-generators'),
  sdk = require('postman-collection'),
  request = new sdk.Request('https://www.google.com'),
  language = 'nodejs',
  variant = 'request',
  options = {
    indentCount: 3,
    indentType: 'Space',
    trimRequestBody: true,
    followRedirect: true
  };
codegen.convert(language, variant, request, options,
  function(error, snippet) {
    if (error) {
      //  handle error
    }
    //  handle snippet..
});

你可以使用该getOptions方法查找目标语言的配置选项：

var codegen = require('postman-code-generators'),
  language = 'nodejs',
  variant = 'Request';

codegen.getOptions(language, variant, function (error, options) {
  if (error) {
    // handle error
  }
  console.log(options);
});

该getLanguageList方法返回你的请求客户端代码可以定位的可用语言：

var codegen = require('postman-code-generators'),
  supportedCodegens = codegen.getLanguageList();
  console.log(supportedCodegens);

支持的语言​

由于代码生成器模块是一个开源项目，如果有一种语言或框架你希望能够为其生成客户端代码，但目前没有提供，你可以通过为项目做贡献来自己添加 它 。这使人们不仅可以使用代码实用程序访问你的贡献，还可以在 Postman 本身中访问你的贡献。

下一步​

如果你使用 Postman 来处理客户端应用程序，你还可以捕获请求数据：