Get Help Log in to Postman
Document APIs

Document APIs

Learn how to create comprehensive documentation that helps people understand what your API does, what endpoints are available and how to successfully interact with them

rate limit

Code not recognized.

About this module

In this module, you will learn how to:

  • Create public documentation
  • Write markdown descriptions at request, folder, or collection level
  • Embed 'Run in Postman' button with documentation
  • Preview docs before publishing
  • Publish to API Network

Chapters25 mins

  • Document APIs in Postman
  • Why should you document APIs?
  • Document your API
  • Publish your documentation
  • Test your knowledge
  • Quiz: Document APIs
  • Wrapping up
  • Resources
  • Recap

About this module

In this module, you will learn how to:

  • Create public documentation
  • Write markdown descriptions at request, folder, or collection level
  • Embed 'Run in Postman' button with documentation
  • Preview docs before publishing
  • Publish to API Network

Chapters25 mins

  • Document APIs in Postman
  • Why should you document APIs?
  • Document your API
  • Publish your documentation
  • Test your knowledge
  • Quiz: Document APIs
  • Wrapping up
  • Resources
  • Recap