Documenting at the Endpoint Level

Key points in this video

Some things to include in your endpoint's documentation

Technical information

  • method and path
  • parameters (URL, query, body)
  • headers
  • authentication/authorization
  • response format/structure/description
  • rate-limiting

Usage information

  • explanation of terms
  • capabilities
  • usage context
  • examples
  • gotchas

Usage information can be placed before, after or within the technical information. For instance, you could place extra details about parameters in the parameter description.

Some examples we looked at:


In the last lesson, you documented Hazam at the API level. Now practice documenting a few endpoints.

Complete and Continue