Generating and Publishing API Documentation
Documentation from Collections
Postman can automatically generate documentation from a collection's requests, including URLs, parameters, headers, and example responses - no separate writing tool needed.
Adding Descriptions
Adding descriptions to requests, folders, and the collection itself (Markdown is supported) makes the generated documentation far more useful and readable for other developers.
Publishing Documentation
| Step | Action |
|---|---|
| 1 | Open the collection and select "View Documentation" |
| 2 | Click Publish to generate a shareable public or private link |
| 3 | Share the link with the team or external consumers |
Keeping Docs in Sync
Because the documentation is generated straight from the collection, updating a request automatically keeps the published docs accurate.
Documentation describes how an API should behave - and Postman can also simulate that behavior before the real API even exists, using mock servers.
Ready to master Postman API Testing Course?
Join Uncodemy's hands-on training and build real-world API testing skills with expert mentors.