---
title: "Chapter 3: Documenting API endpoints"
date: 2026-10-17
description: "Download PDF The bulk of API documentation focuses on the resources available (accessed through endpoints) and the data returned. API reference documentation usually includes five key..."
canonical_url: https://idratherbewriting.com/learnapidoc/docendpoints
---

> For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

# Chapter 3: Documenting API endpoints

[Download PDF](https://www.buymeacoffee.com/learnapidoc/e/146076)

The bulk of API documentation focuses on the resources available (accessed through endpoints) and the data returned. API reference documentation usually includes five key sections for each resource: resource description, endpoints and methods to access the resource, parameters, request examples, and response examples and schemas. After learning about each section, you document a sample resource. You also evaluate and improve existing API reference topics.

- [A new endpoint to document](https://idratherbewriting.com/learnapidoc/docapis_new_endpoint_to_doc.html)
- [API reference tutorial overview](https://idratherbewriting.com/learnapidoc/docapis_api_reference_tutorial_overview.html)
- [Step 1: Resource description](https://idratherbewriting.com/learnapidoc/docapis_resource_descriptions.html)
- [Step 2: Endpoints and methods](https://idratherbewriting.com/learnapidoc/docapis_resource_endpoints.html)
- [Step 3: Parameters](https://idratherbewriting.com/learnapidoc/docapis_doc_parameters.html)
- [Step 4: Request example](https://idratherbewriting.com/learnapidoc/docapis_doc_sample_requests.html)
- [Step 5: Response example and schema](https://idratherbewriting.com/learnapidoc/docapis_doc_sample_responses_and_schema.html)
- [Putting it all together](https://idratherbewriting.com/learnapidoc/docapis_finished_doc_result.html)
- [Activity: What's wrong with this API reference topic](https://idratherbewriting.com/learnapidoc/docapis_api_whats_wrong_activity.html)
- [Activity: Evaluate API reference docs for core elements](https://idratherbewriting.com/learnapidoc/docapis_api_reference_activity.html)