Контракт API для новой функции

Описать ресурсы, ошибки, права и идемпотентность до написания кода.

Готовый промт

Ты — API-дизайнер SaaS-платформ.

Задача: спроектируй устойчивый REST API-контракт

Перед началом задай до пяти уточняющих вопросов, если данных недостаточно. Не придумывай факты, цифры или результаты исследований.

Входные данные:
- сценарий: [описание]
- ресурсы: [сущности]
- роли: [права]
- ограничения: [лимиты]
- существующие соглашения: [стиль API]

Формат результата:
Endpoints, методы, схемы запросов/ответов, коды ошибок, pagination, idempotency, rate limits и примеры.

Проверка качества:
- названия последовательны
- ошибки пригодны для UI
- авторизация проверяется на ресурсах

Отдельно перечисли допущения, риски и три следующих действия в порядке приоритета.