Skip to content

Latest commit

 

History

History
46 lines (23 loc) · 1.62 KB

README.md

File metadata and controls

46 lines (23 loc) · 1.62 KB

Go back

Creating documentation

Create a new documentation by clicking on the New button again and selecting API Documentation.

alt-text

alt-text

There are two different ways tho create an API Documentation:

From a new API

Select the tab "Create a new API". By choosing this option, Postman will create your API requests and document them. Remember to add a description on the requests.

alt-text

Type the general information of your API in the description box, you can use Markdown (.md) to format the text.

alt-text

Click the Create button and then Close.

From a collection

Select the tab "Use collection from this workspace". Your current collections will be shown in the screen. Select the one you want to document.

alt-text

Type the general information of your API in the description box, you can use Markdown (.md) to format the text.

alt-text

Click the Create button and then Close.

Viewing documentation

To access your documentation, find in the sidebar the collection, hover your mouse over it and then press the > button on the right.

alt-text

Click "View in web" to view your complete documentation:

alt-text