Overview

The overview focuses on the market problem that the API solves. The API overview usually appears on the homepage of the API.

The overview explains what you can do with the API (high-level business goals), and who the API is for. Answer these questions:

• What is the App?
• Why use the App API?

Examples of Real Overviews

• Send Grid
• Lyft
• IBM Watson Assistant

Put a link to your Getting Started tutorial on your documentation homepage. Make it as easy as possible for developers to use the API to get some result. If this means using pre-provisioned accounts or setup configurations, do so.

Getting Started