{"_id":"@apib2/postman","_rev":"1-98c5091dd62b25d2dac06bee3fd0671e","name":"@apib2/postman","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@apib2/postman","description":"Convert API Blueprints to Postman","version":"1.0.0","license":"MIT","dependencies":{"apib-include-directive":"^0.1.0","drafter.js":"^2.6.7","handlebars":"^4.0.11","lodash":"^4.17.10","nopt":"^3.0.6","uritemplate":"^0.3.4"},"bin":{"apib2postman":"./bin/apib2postman.js"},"repository":{"type":"git","url":"git+git@github.jci.com:jchrisco/apib2.git"},"_id":"@apib2/postman@1.0.0","_npmVersion":"5.6.0","_nodeVersion":"8.11.3","_npmUser":{"name":"jchrisco","email":"connor.christie@jci.com"},"dist":{"integrity":"sha512-IOXOeRBRQ/8UGtTxiNn2MdghwLSQGs6VzKpmZ5rIyI7YJL2eJUPTlxXY8YNj+q4pmzkoThPduw2xYI7heS2ekg==","shasum":"405e08aa9d0c09d2cfbe114c973992c7027844c5","tarball":"https://registry.npmjs.org/@apib2/postman/-/postman-1.0.0.tgz","fileCount":30,"unpackedSize":4794273,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbYylWCRA9TVsSAnZWagAA1o8P/iNOHPaehJ1OMUjLG3v4\nI0wehd47KrI8q+yThW3QGnHgOqfbzyBKVWYD/Xmf1f7dWQzRXCO87ch02AHu\ntIWxMqpJKjtySZWGNr3JDnrZ5wleL1ygSWPDXLNDMjn54O5DKRZZNs4bjvjJ\nzvJ9wH9c8Slv7LSRXQAIWqPq+qTiEzR/GfNL43gcIKgFdWNKVHntweJ94D2g\nvgf1iWbuAELpRJKrhXFjMNMfFvs/opwLZ3jyiscAeR7vbwO2ESw+eUoLF3YB\naGcy8gS+wqxrSFa+/rbRfBkowQUJuHZQYwNrBFRyLGi0Lp36rFHFWijo7iwF\nP5Mqv80/nd5SFImOsbSgHR8yc+sJVynQOYIUKJQDv52kqWfbg8sqzVfjZbZN\nvimKu/ukWMPIVNLAckoXOL0utrrE9n6rMEKk75BMrmsVwfQiRl1XfK7GGbpJ\nnmO5xtlJT18dbaRIqYluUiW7UW1JCck+srRToaYprqHTBd1FfwtjIl2/Kf0w\nkuDzu7FGHgj9R1gvZG7HP6QsZHHnBJl74Sst8JrNn1qQGS2UWPiIADEhYunq\njN+tbpt817eEii75UfwMe1uUq8XD1Fxbrh9uJEemIl40Beg3mnMTk3QXehE4\n0MImSuIpfVTM8t5JbAX7nVzIgTyBummBvnBQ2jfNJ8AUEprx+ENxM/wLf2xU\nDvf6\r\n=G6iX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDC0nW+UTsNlyw/tgtWcJZ3kjNkieQQOmrax8lUVY9LAwIhAOFdyT04HerFi8FPbutVBTHRch9cXigfuOBL7Flrbwnh"}]},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/postman_1.0.0_1533225302319_0.600139561013928"},"_hasShrinkwrap":false}},"time":{"created":"2018-08-02T15:55:02.085Z","1.0.0":"2018-08-02T15:55:02.434Z","modified":"2022-04-04T14:34:52.000Z"},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"description":"Convert API Blueprints to Postman","repository":{"type":"git","url":"git+git@github.jci.com:jchrisco/apib2.git"},"license":"MIT","readme":"# API Blueprint to Postman\r\n\r\n## Quick Start\r\n1. Install the package globally\r\n    ```\r\n    npm i -g @apib2/postman\r\n    ```\r\n\r\n## Command Line Options\r\n```\r\napib2postman <api-blueprint.apib> [options]\r\n\r\nor\r\n\r\nnode ./bin/apib2postman.js <api-blueprint.apib> [options]\r\n```\r\n\r\n* `-o <output>`, `--output <output>`\r\n\r\n    Default `stdout`\r\n\r\n    Specify a file for where the collection will be saved.\r\n\r\n* `-e <env-output>`, `--environment <env-output>`\r\n\r\n    Default `API.postman_environment.json`\r\n\r\n    Specify a file for where the environment template will be saved.\r\n\r\n* `-t <test-template>`, `--testTemplate <test-template>`\r\n\r\n    Default `templates/postman/actions/js-tests.hbs`\r\n\r\n    Specify a handlebar template to be used for each action's Postman tests. Variables are listed below which can be used within the template.\r\n\r\n## Postman Test Template\r\nSome JS tests have been created which get templated and attached to every action. The default tests exist at `templates/postman/js-tests.hbs`\r\n\r\nThis template is applied to every action and the variables which get passed to this template are as follows:\r\n\r\n| Name | Description | Example |\r\n| ---- | ----------- | ------- |\r\n| pathName | The path of the group collection as a standardized name. | `networkDevices_` for /api/networkDevices/:id |\r\n| statusCode | The expected status code for the action | `200` |\r\n| headers | The expected headers to be returned | `[ { key: \"Accept\", value: \"application/json\" } ]` |\r\n| schema | The JSON schema for the action's response | `{ large schema here... }` |\r\n| isPageable | Returns true if the response schema has a collection within | `true` |\r\n| sortParams | The accepted sort parameters parsed from the sort query parameter description | `[ \"name\", \"category\" ]` |","readmeFilename":"README.md"}