---
title: "API reference tutorial overview"
date: 2026-10-01
description: "Download PDF In this API reference tutorial, we’ll work on creating five common sections in REST API reference documentation: resource description, endpoints and methods, parameters, request..."
canonical_url: https://idratherbewriting.com/learnapidoc/docapis_api_reference_tutorial_overview
---

> 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.

# API reference tutorial overview

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

In this API reference tutorial, we’ll work on creating five common sections in REST API reference documentation: resource description, endpoints and methods, parameters, request example, and response example and schema. To provide some context (and to continue with our sample documentation scenario), we’ll structure the information from the [new endpoint to document](https://idratherbewriting.com/learnapidoc/docapis_new_endpoint_to_doc.html#surf_report_api) into these five sections.

## Five common sections in REST API docs

Almost all API reference topics include these five sections:

**[1. Resource description](https://idratherbewriting.com/learnapidoc/docapis_resource_descriptions.html)**
.

**[2. Endpoints and methods](https://idratherbewriting.com/learnapidoc/docapis_resource_endpoints.html)**
.

**[3. Parameters](https://idratherbewriting.com/learnapidoc/docapis_doc_parameters.html)**
Options that can be passed with an endpoint to influence the response, such as specifying the response format or number of results returned.

**[4. Request example](https://idratherbewriting.com/learnapidoc/docapis_doc_sample_requests.html)**
A sample API request showcasing how the endpoint should be accessed, including any required headers, parameters, or body content.

**[5. Response example and schema](https://idratherbewriting.com/learnapidoc/docapis_doc_sample_responses_and_schema.html)**
.

## Tutorial workflow map

The tutorial here includes a workflow map to help guide and orient you each step of the way.

[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)

## After the tutorial

When we’re finished, the end result will look like a real API help topic (see the finished result in [Putting it all together](https://idratherbewriting.com/learnapidoc/docapis_finished_doc_result.html)). In the associated activities, you’ll have an opportunity to [edit or create an API reference topic](https://idratherbewriting.com/learnapidoc/docapis_api_reference_activity.html) with your own [open-source API project](https://idratherbewriting.com/learnapidoc/docapis_find_open_source_project.html).

Although there are automated ways to publish API docs, we’re focusing on content rather than tools in this section. In the next section, [OpenAPI spec and generated reference docs](https://idratherbewriting.com/learnapidoc/restapispecifications.html), we’ll look at how to describe these same reference components using the OpenAPI specification. In the [Publishing your API documentation section](https://idratherbewriting.com/learnapidoc/publishingapis.html), we’ll look at ways to publish the information.

## Next steps

Now that you have an idea of the tutorial, let’s get started with the first section: [Step 1: Resource description](https://idratherbewriting.com/learnapidoc/docapis_resource_descriptions.html).