代码生成器库

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

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

您可以从npm安装代码生成器库,也可以从其 repo 克隆它

您还可以在 Postman 应用程序中为请求或集合生成客户端代码。

以编程方式使用代码生成

以下简化的代码摘录演示convert了如何使用 Collection 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 应用程序本身中访问您的贡献。

下一步

要开始使用代码生成器模块,请查看 GitHub 上项目 repo 中的安装和使用说明。如果您使用 Postman 来处理客户端应用程序,您可能还会发现捕获请求数据很有用。