p8ul / postman2apiary

Tool for generating Blueprint API markup or the Apiary API from a Postman collection.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Postman2Apiary

Tool for generating Blueprint API markup or the Apiary API from a Postman collection.

Edit your postman collection requests with relevant names and description. Import postman_collection.json from postman2apiary/app/ for a quick demo on how to name and describe your requests. Expected output should be something like Polls api documentation.

Prerequisites

python version 3+

Installation

git clone https://github.com/p8ul/postman2apiary.git
cd postman2apiary/app

Usage

CLI application Application takes three arguments.
USAGE: $ python run.py [postman.json-file] [output-file.apid]

postman.json-file: Json file exported from Postman collection
output-file.apid: Name of your api markup file to be generated.

Contribution

Contributions are greatly appreciated. What is most lacking is indentation on request & response expected json. Tests would be super-greatly appreciated too.

License

Postman2apiary is MIT Licensed

About

Tool for generating Blueprint API markup or the Apiary API from a Postman collection.

License:MIT License


Languages

Language:Python 100.0%