Версия источника: 4880e8b4372c96001c2e052be28b68a95d31252b
Синхронизировано: 2026-11-09T11:15:07.649Z
Источник: https://github.com/sergey-from-riders/vibecoding-base/tree/4880e8b4372c96001c2e052be28b68a95d31252b

<a id="api-openapi"></a>

# OpenAPI-контракт

## Коротко

В контракте должны быть реальные методы, схемы, ошибки, доступ и примеры.

## Плохо

```text
Новый endpoint работает, но в документации его нет.
```

## Хорошо

```text
Изменены обработчик, OpenAPI, пример и тест.
operationId уникален и стабилен.
```

## Почему

Клиенты и агенты не должны угадывать формат запроса.

## Когда применять

OpenAPI 3.2 подходит при поддержке инструментов; 3.1 остаётся допустимым осознанным выбором. Разбиение по модулям зависит от размера API.

## Как проверить

- Сопоставьте реальные маршруты, операции контракта и каталог endpoints.

## Человек

Утверждает публичные поля и обязательства перед клиентами.

## Агент

Реализует серверный контракт и проверяет успешный запрос, неверный ввод и повторное обращение.

Контроль результата:

- Сопоставьте реальные маршруты, операции контракта и каталог endpoints.

## Источники

- [OpenAPI Specification v3.2.0](https://spec.openapis.org/oas/v3.2.0.html)

Уровень: Рекомендуется. Проверено: 2026-11-09. Изменено: 2026-11-09.

[Исходный файл](https://github.com/sergey-from-riders/vibecoding-base/blob/4880e8b4372c96001c2e052be28b68a95d31252b/registry/standards/api/openapi-modular/rules/openapi.md)