apidoc-postman

> Use apiDoc to create a Postman collection.


This library uses the apidoc-core library.

How It Works

By putting apiDoc inline comments in the source code, you will get a postman.json file which can be imported into the Postman App to create a new collection.

E.g.

``js
/**
* @api {get} /user/id Request User information
* @apiName GetUser
* @apiGroup User
* @apiPermission basic
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
`

Installation

npm install @panz3r/apidoc-postman

Features

apidoc-postman takes full advantage of Postman environment variables for the following aspects

$3

Using the base_url environment variable you can specify the base URL of your APIs.

$3

apidoc-postman uses a simple logic to map your endpoints permissions to Postman ones.

You can set your endpoint @apiPermission to basic to have a Basic authentication on Postman, otherwise the Bearer authentication will be used by creating a reference to an environment variable called <@apiPermission>_token.

E.g. @apiPermission user maps to user_token.

N.B: At the moment only Basic and Bearer authentications are supported

$3

apidoc-postman will setup Postman to use application/json body format and will create a template body based on the @apiParam Body group.

E.g.
`js
/**
* @apiParam (Body) {Number} id ID of the User.
* @apiParam (Body) {String} name Name of the User.
*/
`
will translate to the following template body
`json
{
"id": 0,
"name": "string"
}
`

Example

apidoc-postman -i example/ -o doc/

Have a look at apiDoc for full functionality overview and capabilities of apiDoc.

$3

`json
{
"base_url": "https://localhost:8000/api/v1",
"basic_username": "basic_auth_username",
"basic_password": "basic_auth_password",
"user_token": "a.user.bearer.token"
}
``

---

Made with :sparkles: & :heart: by Mattia Panzeri and contributors