How to Read and Understand API Documentations

Explained with the Stripe API example

If someone told you to “check the API doc” and you did, but are not sure what you’re looking at, this is for you.

APIs are everywhere. They connect different apps together and are the backbone of most integrations. In other words, APIs are a common language that is used to communicate between different systems.

The better the [API] documentation, the higher the rate of adoption and the fewer the questions to technical support.

Don’t worry, you don’t need to have a technical background to continue. The main idea is that there is an exchange of requests and responses. But how might we know what to ask and what results to expect? The answer lies in understanding the API documentation.

Not All API Documentation is Created Equal

Not all API documentation is created equal. Some are excellent and others…not so much (do they even exist?). So what makes API documentation great versus a poorly written one?

Readability.

The best API docs are a self-service reference that succinctly explains what is possible, what is not, and how to…