OpenAPI — это язык описания REST API в формате JSON или YAML.
Это единый «паспорт» вашего API, в котором прописано всё:
- Какие есть URL-адреса (эндпоинты).
- Какие параметры принимает каждый запрос (в пути, в строке запроса, в теле).
- Какие структуры данных возвращаются в ответе.
- Какие типы ошибок могут возникнуть.
- Как проходит авторизация (токены, ключи).