API documentation

API documentation is a reference for your API aimed at developers: a list of methods (endpoints), their parameters, request and response formats, error codes and authentication. For each method there are request examples (curl, Python, JavaScript) and responses, and an interactive console lets you send a test request right from the documentation. It is often generated from an OpenAPI/Swagger spec and updated together with the API. Unlike a help center for users (see the “Help Center” service) and a documentation website with product guides (see the “Documentation website” service), API documentation is highly specialized, for those who integrate with your API. Ready generators (Swagger UI, Redoc) are free and quickly build a reference from a spec — for a standard API they are often enough, and if Swagger is enough for you, use Swagger. Your own API documentation is needed when you need more than a bare reference: guides and integration scenarios next to the reference, your own brand and UX, non-standard authentication, a sandbox and test keys, combining several APIs and versions, integration with your developer portal. The base price starts from 130,000 ₽; the total depends on the number of methods, interactivity and spec integration.

• Integrators flood support with “how to call a method” questions — there is no clear API reference.
• API documentation is maintained by hand and lags behind the code — examples do not work, methods are outdated.
• A developer has nowhere to try a request — they have to build everything from scratch and guess.
• You need to describe authentication, errors and formats so integrators connect on their own.

• Method reference: endpoints, parameters, types, request and response formats
• Request and response examples in different languages (curl, Python, JavaScript)
• Authentication: API keys, OAuth, headers — described and shown
• Error codes and their handling
• An interactive “try it” console: a test request right from the documentation
• Generation from an OpenAPI/Swagger spec and sync with API updates (optional)
• API versions, a changelog; search across methods
• Your own brand, integration guides next to the reference, responsive, dark theme

• Integrators connect to the API themselves using the reference and examples — fewer “how to call a method” tickets
• The documentation is a single source of truth for the API: generated from the spec and never diverging from the code
• You can try a request right away and get a working example — integration goes faster
• Fewer integration mistakes: authentication, error codes and formats are described unambiguously

• You leave a request and send an API description or an OpenAPI spec
• We design the reference structure, examples, authentication and interactivity
• We develop, connect the spec and launch

• How is API documentation different from a documentation website and a help center?

  API documentation is a narrow reference for the API aimed at developers: methods, parameters, request examples. A documentation website is the whole product: guides, instructions, reference. A help center is short answers for end users. They are often parts of one portal, but API docs are the most technical part.

• Can documentation be generated from OpenAPI/Swagger?

  Yes. If you have an OpenAPI spec, the documentation is generated from it and updated together with the API — examples and methods do not lag behind the code. If there is no spec, we will help build it or maintain the documentation by hand.

• Why pay if Swagger and Redoc are free?

  If the task is just a reference from a ready spec, it is cheaper and faster to use free Swagger or Redoc — and that is a fine choice. Our work pays off when you need a branded developer portal: guides and integration scenarios next to the reference, non-standard authentication, a sandbox, combining several APIs and versions, integration with your systems. The base price starts from 130,000 ₽; we calculate the exact one after you describe the API.