p8ul / postman2apiary

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

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

postman2apiary's Issues

Postman collection V2.1

When using Postman Collection v2.1 error

Traceback (most recent call last):
  File "run.py", line 35, in <module>
    main()
  File "run.py", line 28, in main
    app = PostmanToApiary(data)
  File "path\converter.py", line 22, in __init__
    self.get_data()
  File "path\converter.py", line 33, in get_data
    self.name = self.data['name']
KeyError: 'name'```