تولید کد کلاینت از درخواست‌ها و Collectionهای Postman

Postman می‌تواند از درخواست‌ها و Collectionهای شما کد کلاینت تولید کند. در سطح برنامه‌نویسی، این کار با ماژول Node.js کدساز Postman انجام می‌شود؛ ماژولی که یک شیء Request از Collection SDK را می‌گیرد و برای زبان و فریم‌ورک هدف، snippet تولید می‌کند.

این ابزار چه مشکلی را حل می‌کند؟

وقتی یک درخواست API در Postman آماده شده است، معمولا لازم است همان درخواست در یک برنامه واقعی هم پیاده‌سازی شود. کدساز Postman کمک می‌کند نمونه کد اولیه برای زبان‌هایی مثل Node.js و سایر هدف‌های پشتیبانی‌شده تولید شود تا توسعه‌دهنده از نو همه جزئیات درخواست را ننویسد.

دسترسی و نصب

تولید کد با convert

نمونه زیر یک Request با Collection SDK می‌سازد، زبان هدف را Node.js قرار می‌دهد و با متد convert خروجی snippet را تولید می‌کند:

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..
});

دیدن گزینه‌های زبان هدف

برای هر زبان یا variant ممکن است گزینه‌های پیکربندی متفاوتی وجود داشته باشد. با 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);
});

دیدن زبان‌های پشتیبانی‌شده

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

نکته توسعه‌دهندگان

این ماژول متن‌باز است. اگر زبان یا فریم‌ورک خاصی در فهرست خروجی‌ها وجود ندارد، می‌توانید در پروژه مشارکت کنید تا آن گزینه هم در مخزن و هم در تجربه Postman در دسترس کاربران قرار بگیرد.

منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.