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

Documenting API endpoints

Reference documentation for API endpoints conforms to five general sections: resource descriptions, endpoints and methods, parameters, sample requests, sample responses and schemas. When you document an API, provide detailed information for each of these reference 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: Find an Open Source Project
• Activity: Evaluate API reference docs for core elements

Donate?

Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.