RestFul Api documentation with Swagger

API Documentation

Presenter: Naincy GuptaMindfire Solutions

Simple Steps to create RestFul API document

About Me Certifications:M70 101 - Magento Certified DeveloperOCA 870 - MYSQL

Contact Me: Email: [email protected]: mfsi_naincy.gupta

Connect Me: -Facebook : https://www.facebook.com/naincy.gupta.35574LinkedIn : in.linkedin.com/pub/naincy-gupta/66/440/6a3/Google+: https://plus.google.com/u/0/+NaincyGuptaTechSharing/postsBlog: http://[email protected]

STEP 1

- Open POSTMAN, and create a collection with any name. Eg. My collection

- Run your API call in POSTMAN.

- Save your API calls in the collection created.

- Go to your collection and download the collection

- Save downloaded collection.

STEP 2

- Open any converter to transform API into another fomat. (https://apitransformer.com/#convert)- Select the format in which you want to convert (Swagger YAML or Swagger JSON)

- Click to Transform your API Collection(Will give you a converted file.)

STEP 3

- Open swagger editor (http://editor.swagger.io/#/)- Import the converted file.

- Its Done! (Your document is ready)

Other Benefits

- Once your document ready, you will be able to download client in any format various options are avaialble like HTML, PHP, C#, Ruby, Python, Perl, Java, etc.

Thank You!