Documentation/API documentation/Overview
 | This page is currently a draft.
|
This page outlines the content you should include in the overview section of your API documentation. For simple APIs, all the necessary overview content may fit on a single page, which could be the landing page. However, usually API documentation is complex and lengthy enough that you must distribute this information across multiple pages. Use this guide to help you determine which information to group into sections or pages.
For additional content, style, and formatting guidance, see the general overview template.
Overview of the API
[edit]API overview documentation must include the following basic info.
API features and status
[edit]Include on main overview page (which could also be your landing page):
- The core resources (data) to which the API provides access
- API comparison (why use this API vs others)
- What framework does the API use? (REST? something else?)
- Wiki projects and languages included
- Status of the API (stable, experimental)
Key concepts
[edit]- Unfamiliar terms
- Special topics relevant to your domain
Data formats
[edit]Include on main overview page (which could also be your landing page):
- Data format
- URL structure
- Sample call
Access policy
[edit]Include this content on the page, or provide a prominent link to it.
Rate limits
[edit]Include this content on the page, or provide a prominent link to it.
Stability policy
[edit]Include this content on the page, or provide a prominent link to it.
Next steps
[edit]At the end of the overview section or page, link to or include a quick start or link to API reference content.