The API Proposal

Learn how to write API proposal documents before building an API.

We'll cover the following

In a small organization, the API team can usually build APIs independently, but in most larger organizations, an API governance team will approve any APIs being built. Before we start building an API, we must put together a product specification document that talks about what the API is required to do. This is a simple document that maps out the API workflow and narrates the story of why this API needs to be built.

API proposal document

This API proposal document should map out the workflow of the API, along with various user stories. User stories are written in the format shown in the following illustration.

Get hands-on with 1200+ tech skills courses.