1. I'd Rather Be Writing
2. Learn API Doc
3. Documenting API endpoints

Documenting API endpoints

I'm giving an API documentation workshop in San Francisco, California, on November 19, 2019. Check it out on EventBrite and register today to receive a $100 early bird discount.

Reference documentation for API endpoints consists of five general sections: resource descriptions, endpoints and methods, parameters, sample requests, and sample responses and schemas. To document the reference endpoints of an API, provide detailed information for each of these sections.

Sections in this chapter:

• A new endpoint to document
• API reference tutorial overview
• Step 1: Resource description
• Step 2: Endpoints and methods
• Step 3: Parameters
• Step 4: Request example
• Step 5: Response example and schema
• Putting it all together
• Activity: What's wrong with this API reference topic
• Activity: Evaluate API reference docs for core elements

Donate?

Want to buy me lunch? Click the Donate button below to donate any amount through Paypal.