OpenAPI — это стандарт машиночитаемого описания REST API: эндпоинтов, параметров, схем и ошибок; на его основе создают типизированные клиентские библиотеки, документацию и коллекции запросов.
Файл OpenAPI в YAML или JSON описывает эндпоинты настолько подробно, что инструменты могут создать клиент для TypeScript, Python или Java, импортировать API в Postman или Insomnia, проверять запросы и выводить справочную документацию. Для небольшого API такая спецификация может заменить официальные SDK и обновляться вместе с интерфейсом.
Это также самый полезный источник данных для ИИ-помощника, который должен правильно построить интеграцию с API.
В SMSMeteor: спецификация OpenAPI 3.1 доступна по адресу /docs/openapi.yaml и версионируется вместе с API; примеры генерации клиентов приведены на странице SDK.