---

CLI for converting open api documentation to postman collection with additional options for integration testing

❯ Installation

Use the package manager npm which is bundled with node to install ufonaut.

npm install -g @b-pagis/ufonaut

❯ Usage

📜 NOTICE: By default this utility, when converting, replaces request body, header and query parameters' values with interpolated parameter names. As an example "keyName":"<string>" will be replaced with "keyName":"{{keyName}}". This gives flexibility and ability to contain all information in variables.

Run interactive mode

ufonaut

or

ufonaut cli

Convert Open API documentation to postman collection

ufonaut convert -i [file-location] -o [output-file-location]

Other options

Create a set

ufonaut create-sets -i [file-location] -o [output-file-location] -c [sets-config-location]

Other options

List endpoints in open api documentation

ufonaut endpoints -i [file-location]

Other options

Ordering

Option that allows ordering endpoints in the specified way. This option will provide postman collection with flat structure. Not specified endpoints are included into the list after ordered ones.

Config file example

{
  "order": [
    {
      "method": "post",
      "path": "user"
    },
    {
      "method": "post",
      "path": "store/order"
    },
    {
      "method": "get",
      "path": "pet/findByStatus"
    }
  ]
}

Sets

Option that allows to create small postman collections for dedicated scenarios.

Config options

Config example

{
  "sets": [
    {
      "collectionName": "pc-sets-store-example",
      "scriptsPath": "examples/scripts",
      "template": {
        "preRequestTemplateFilePath": "examples/scripts/template/pre-request.template"
      },
      "auth": {
        "type": "basic",
        "forced": false,
        "basic": {
          "username": "user",
          "password": "user-password"
        }
      },
      "order": [
        {
          "method": "post",
          "path": "store/order"
        },
        {
          "method": "get",
          "path": "store/order/:orderId"
        },
        {
          "method": "get",
          "path": "store/inventory"
        }
      ]
    },
    {
      "collectionName": "pc-sets-pet-example",
      "auth": {
        "type": "apikey",
        "apikey": {
          "location": "header",
          "key": "x-my-key",
          "value": "key-123"
        }
      },
      "order": [
        {
          "method": "get",
          "path": "pet/findByStatus"
        },
        {
          "method": "put",
          "path": "pet"
        },
        {
          "method": "get",
          "path": "pet/findByTags"
        },
        {
          "method": "delete",
          "path": "pet/:petId"
        },
        {
          "method": "post",
          "path": "pet"
        }
      ]
    }
  ]
}

📜 NOTICE: Only those endpoints that are specified in set config will be included into set.

Scripts

When storing everything in variables, it becomes possible to have some kind of content manipulation in either pre-request or test tab. This options gives possibility to load pre-request and test scripts from files to endpoints. However this option enforces some path and file name rules.

Path rules

Path must contain two catalogs that are named pre-request and test in it.

File name

Each catalog must contain a .js file with following rules method-path, where:

• method - is HTTP method (e.g. post, get, etc)
• path - is full path to the resource with removed non letter symbols, except dash, from it and placed in lowercase. E.g. for endpoint that is named GET /pet/findByStatus-example - the file name must be get-petfindbystatus-example.js.

Catalog structure example

.
├── scripts
    ├── pre-request
    │   └── get-petfindbystatus-example.js
    └── test
        └── get-petfindbystatus-example.js

Script templates

Postman does not allow direct body manipulation (see #4808). The only way to do it, is to put request body into variable that can be used in pre-request script, but doing it manually is very tedious task. With this option it is possible to automate this task, by creating a template that will be used in every endpoint that has request body.

Template supports following parameters:

• requestBody - will be replaced by actual request body. In the request tab a {{requestBody}} parameter will be placed instead of actual request.
• scriptContent - will be replaced with the content of pre-request script file.

Parameters must be entered between <%%= and =%%>.

Template example

var requestBody = <%%=requestBody=%%>;

<%%=scriptContent=%%>

pm.environment.set('requestBody', JSON.stringify(requestBody));

❯ Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

📜 NOTICE: if you are working on Windows, then following scripts will not work

• refresh,
• clean:all,
• clean:lib,
• build,
• start

This is because rm -rf command is used. Please adjust it locally and please avoid committing updated commands. Thank you in advance for your contribution.

❯ License

ISC