API Template MS Word – Use this 28-page MS Word template to document your REST/Web APIs. This template pack includes detailed examples, guidelines, and screenshots.
API Writing Tutorial – It also includes a 16 page How to Write API Document tutorial that explains how to write each section in your API reference documentation. It includes helpful explanatory text that walks you through the process of documenting each section in the API, including the parameters, endpoints, requests, responses, and endpoints.
Table of Contents
The API template includes the following chapters:
1.0 Overview
1.1. Conventions
1.2. Current Version
1.3. Schema
1.4. HTTP Redirects
1.5. HTTP Requests
1.6. HTTP Methods
1.7. Authentication
1.8. Pagination
1.9. Rate Limiting
1.10. URL Format
2.0 API Reference Documentation
2.1. Overview
3.0 Resource Name [with instructions]
3.1. Resource Information
3.2. Request
3.1. Parameters
3.2. Authorization
3.3. Response
3.1. Samples
4. Resource Name [#1]
4.1. Resource Information
4.2. Request
4.3. Parameters
4.4. Authorization
4.5. Response
4.6. Samples
5. Resource Name [#2]
5.1. Resource Information
5.2. Request
5.3. Parameters
5.4. Authorization
5.5. Response
5.6. Samples
6. Query Parameters
7. Status Codes
How to Write API Documentation – Tutorial
You also get a 16 page How to Write API Document tutorial that explains how to write each section in your API reference documentation.
It includes helpful explanatory text that walks you through the process of documenting each section in the API, including the parameters, endpoints, requests, responses, and endpoints.
The How to Write API Document ebook is:
- Page Count: 16 Pages
- Language: US English
- File Format: PDF