Content structure
Understand the recommended content structure for API developer portals.
Below, you can find an overview of the content structure with the links to detailed descriptions.
Overview of the content structure
| Level 0 | Level 1 | Level 2 | Required |
|---|---|---|---|
| Landing page | Yes | ||
| <API Name> overview | Yes | ||
| Integration guide | No | ||
| Changelog | Yes | ||
| Getting started | Yes | ||
| Accessing the API | Yes | ||
| Using <API Name> | Yes | ||
| Tutorials | Yes | ||
| <Sample app or use case> | Yes | ||
| <API Name> reference | Yes | ||
| Resource 1 | Yes | ||
| Resource 2 | No | ||
| SDKs | No | ||
| <Language name> SDK | No | ||
| Troubleshooting | Yes | ||
| <API Name> status | No | ||
| Status and error codes | Yes | ||
| Glossary | No | ||
| Terms of use | Yes |