Skip to content
BENIBIX Learn

API Documentation

Development🔌 APIsAPI Basics

Also known as API Docs, API Reference, API Reference Docs

The guide to an API. It lists each endpoint, what to send and what comes back.

Think of it like

Think of it like the menu in a cafe. It lists every dish, what is in it and what it costs.

Example

Jack reads the docs for a weather API. In ten minutes he finds how to get the forecast, and he copies the sample.

Why it matters

An API is only as useful as its docs. If people cannot learn it, they will not use it.

Definition

API documentation explains how to use an API. It lists each endpoint, what to send and what comes back. It shows the error codes and what each one means. Good docs have examples you can copy and try. Many are made from an OpenAPI file, so they stay in step with the code.
The docs sit between your app and the API, like an open book.

Common mistake

Writing docs once and never again. Out-of-date docs send people down wrong paths.

Key takeaways

  1. 1
    Every endpoint. What to send and what returns.
  2. 2
    Real examples. Code people can copy and run.
  3. 3
    Kept in step. Generate it from the spec.

Compare