ГлоссарийРазработка и API
OpenAPI
Что такое OpenAPI и зачем нужно машинное описание API.
OpenAPI
OpenAPI — стандарт описания REST API. Это документ, который формально описывает все эндпоинты, параметры и форматы ответов.
Зачем нужен
OpenAPI делает API «читаемым» для инструментов: по описанию можно автоматически генерировать SDK, документацию и тесты. Вместо ручного описания каждого эндпоинта вы поддерживаете один файл-источник.
Что даёт
- документация — интерактивная справка по API;
- генерация SDK — клиентские библиотеки создаются из описания;
- валидация — проверка, что запросы и ответы соответствуют схеме.
Для интегратора OpenAPI — быстрый способ понять возможности API, не читая исходный код. AACSearch публикует описание API в этом формате.