API

Понятные запросы, честные статусы и совместимость.

Читать правилаСкачать раздел .md9 правил

Правила 9

APIОбязательно

HTTP-статусы

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

HTTP
Проверено 9 ноября 2026 г.
APIОбязательно

HTTP-методы

GET и HEAD читают; изменение бизнес-состояния должно иметь соответствующий метод.

HTTP
Проверено 9 ноября 2026 г.
APIРекомендуется

Problem Details

Ошибка должна помогать исправить запрос без раскрытия внутреннего устройства сервера.

HTTP
Проверено 9 ноября 2026 г.
APIРекомендуется

OpenAPI-контракт

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

OpenAPI
Проверено 9 ноября 2026 г.
APIОбязательно

Идемпотентность API

После потери ответа повторный запрос не должен создавать вторую оплату или заказ.

HTTP
Проверено 9 ноября 2026 г.
APIРекомендуется

Оптимистическая блокировка

Проверяйте версию записи перед сохранением, если пользователь может перезаписать чужую работу.

HTTP
Проверено 9 ноября 2026 г.
APIРекомендуется

Пагинация

Договоритесь о размере страницы, сортировке, фильтрах и продолжении списка.

HTTP
Проверено 9 ноября 2026 г.
APIОбязательно

Совместимость API

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

OpenAPI
Проверено 9 ноября 2026 г.
APIРекомендуется

HTTP-заголовки

Статус, формат содержимого и кеширование описываются стандартными средствами HTTP.

HTTP
Проверено 9 ноября 2026 г.

Недавно проверено

HTTP-статусыHTTP-методыProblem DetailsOpenAPI-контракт