Files

1.2 KiB

API Contract Rules

Этот rule описывает только тело секции ### Контракт.

Обязательные части

  • request parameters (header/query/path)
  • request body (если применимо)
  • response body
  • errors
  • auth
  • timeout
  • retry/idempotency (если применимо)

Правила заголовков внутри тела секции

  • Не повторять заголовок Контракт.
  • Запрещено выводить ## Контракт и ### Контракт внутри тела секции.
  • Если нужны подзаголовки, использовать только уровень ниже родительской секции: #### Запрос, #### Ответ, #### Ошибки, #### Auth, #### Timeout, #### Retry/Idempotency.

Табличный формат

Для request/response таблицы должны содержать:

  • название
  • тип данных
  • обязательность
  • описание
  • пример

Для response дополнительно:

  • заполнение (mapping/логика источника данных)