API-Documentation-With-Swagger

This Git repository helps you to document the available APIs in the easiest way possible.

Getting Started

Prerequisites

• Requires python3 and above you can install it by going to terminal/cmd prompt.
  On Mac :

  $ brew install python3
  

  On Linux :

  sudo apt-get install python3.6 
  

Installing

• Download the zip/Clone the repository on the machine on the desired place.

Deployment

Steps to be followed :

1 Open the swagger web page of the project for which you want to document the APIs.

2 Naviagte to Networks tab on DevTools windows by press F12 on the swagger web page and then find the V(someno) eg. v1,v2 API call and then proceed to response. Copy the JSON response.

3 Navigate to the downloaded/cloned repository folder and paste the response JSON into data.json file by replacing{}.

4 Open main.py file and run it on the console or any python supported IDE.

5 Your .csv file is ready in the form of output.csv file.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me.

Authors

• Arpit Gole - Initial work - Arpit-Gole