docs.vpodarok.ru — API documentation service

Task

The customer's group of services had accumulated several APIs for clients and partners, and the documentation lived in disparate Swagger files and correspondence. We needed a single tool where the team maintains documentation, and customers read it without contacting support.

Decision

In a month, we built a documentation service: a structure of directories and files, importing existing Swagger descriptions and exporting them back, manually editing methods, global settings, and documentation statistics. Documentation can be made private or open to clients, and work on it can be delegated to third parties with limited rights.

Technologies — Laravel, Alpine.js and TypeScript, MariaDB, GitLab CI. Light frontend without heavy SPA: documentation pages are fast and indexed.

Result

One point of truth for all the customer's APIs. New methods are described in the interface in minutes, partners receive up—to-date documentation and a sandbox, and support provides fewer "how to invoke a method" questions.