Get Help Log in to Postman
Documenting an existing API

Documenting an existing API

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

Limited availability | See below

rate limit

Code not recognized.

About this module

In this module, you will learn how to:

  • Create collections
  • Create requests in a collection
  • Write markdown descriptions at request, folder, or collection level
  • Give feedback in comments on documentation, requests, APIs

Module50 mins

  • Slides (reference)
  • Challenge: Document the Remote Services API
  • Claim your badge
  • Additional resources

About this module

In this module, you will learn how to:

  • Create collections
  • Create requests in a collection
  • Write markdown descriptions at request, folder, or collection level
  • Give feedback in comments on documentation, requests, APIs

Module50 mins

  • Slides (reference)
  • Challenge: Document the Remote Services API
  • Claim your badge
  • Additional resources