Files
agent/_process/doc_rules_v3/common-elements/api-contract.md
T

578 B

API Contract Rules

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

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

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

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

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

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

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