Swagman - Converting Postman Collection to Swagger Build
Download as PPTX, PDF0 likes482 views
This document outlines the prerequisites and installation steps for converting Postman collections to Swagger using the Swagman tool. It includes instructions for setting up an Apache server, installing pip, and cloning the Swagman repository, along with usage commands for the tool. Additional tips for troubleshooting are also provided.
Swagman - Converting Postman Collection to Swagger Build
- 1. Converting Postman Collections to Swagger Build
- 2. Prerequisites ● Apache Server ● pip installed on your machine ● Swagman tool ● Github basics ● Terminal Commands (unzip, mv, mkdir etc.) ● Postman Collection to convert
- 3. Installation: Apache Server 1. $ sudo apt-get install apache2 2. Update the default firewall: a. $ sudo apt-get install apache2 b. Sudo ufw app list c. Sudo ufw allow ‘Apache Full’ 3. Type 127.0.0.1 in your web browser to confirm.
- 4. Installation: pip utility 1. $ sudo apt install python-pip Do not upgrade the pip version. Check the current version with $ pip --version pip is a python manager utility. Swagman is a python built hence the pip is required TIPS
- 5. Installation: Swagman 1. $ Clone a repository from https://github.com/peopledoc/swagman 2. cd where the downloaded swagman-master.zip file: a. $ cd swagman-master 3. Extract the .zip there itself: $ unzip swagman-master.zip 4. Install swagman: a. $ pip install swagman b. $ pip install -e . Do not miss the .
- 6. Postman Collections ● environment.json Environment Quick Look > Edit > Download Environment ● Global.json Quick look > Globals > edit > download ● Postman.json .json of collection you have from Postman.
- 7. Using Swagman ● Command swagman -e <environment.json file path> -g <global.json file path> -f json -H 127.0.0.1 -o <Path where the new.json file should be created> <Path of json collection exported from Postman> If json is not specified in the command, this returns a YAML file by default. The localhost becomes active when Apache Server (or any other) is installed TIPS
- 8. Ping me or Google if stuck!
Editor's Notes
- #4: 2.a. is sufficient. b and c are done to take https request (on 443) also.
- #5: 2.a. is sufficient. b and c are done to take https request (on 443) also.
- #7: Save all these files in a single location for it is easy to remember. Only the path of these files are to be passed as parameters in the swagman command.
- #8: For Example: swagman -e /home/ajinkya.d/Downloads/e.json -g /home/ajinkya.d/Downloads/g.json -f json -H 127.0.0.1 -o /home/ajinkya.d/Downloads/resultsAjinkya.json /home/ajinkya.d/Downloads/clearLimits.postman_collection.json