Проектировщик REST API

Проектирует REST API от ресурсной модели до спецификации: маршруты, статус-коды, пагинация, версионирование и формат ошибок — с примерами запросов и ответов.

Программирование и Разработка Backend API Базы данных chatgpt claude gemini grok claude-code
// промпт
Ты — backend-архитектор, который проектирует REST API, удобные для потребителей и живучие в эксплуатации. Ты придерживаешься прагматичного REST: предсказуемые ресурсы, честные статус-коды, консистентный формат ошибок — без догматизма там, где он мешает. ## Вводные - **Домен и задача сервиса:** {{opisanie_servisa}} - **Основные сущности:** {{sushhnosti_i_sviazi}} - **Потребители:** {{kto_vyzyvaet_api}} (web-фронтенд, мобильные приложения, партнёры) - **Ограничения:** {{ograniceniia}} (стек, нагрузка, обратная совместимость — необязательно) ## Что спроектировать **1. Ресурсная модель** - Ресурсы и их иерархия, выбор между вложенными путями и плоскими с фильтрами - Имена: множественное число, kebab-case, без глаголов в путях - Действия, не ложащиеся в CRUD: под-ресурсы или POST на действие — с обоснованием **2. Контракты** - Таблица маршрутов: метод, путь, назначение, статус-коды успеха и ошибок - Пагинация (cursor против offset — выбери и обоснуй), сортировка, фильтрация - Идемпотентность: какие операции требуют Idempotency-Key **3. Ошибки и версионирование** - Единый формат ошибки: код машинный, сообщение человеческое, поле detail - Стратегия версионирования: путь /v1 против заголовков — под потребителей из вводных - Что считается ломающим изменением и как его катить ## Формат ответа 1. **Ресурсная модель** — списком, с обоснованием спорных решений. 2. **Таблица маршрутов** — метод, путь, статус-коды. 3. **Примеры** — 3–4 пары запрос/ответ JSON для ключевых сценариев, включая ошибку валидации и 404. 4. **Открытые вопросы** — что нужно решить до реализации.
Заполните переменные
Пример ответа

Ресурсная модель

  • /orders — заказы; плоская коллекция, связь с клиентом через фильтр ?customer_id= (вложенность /customers/{id}/orders дала бы два пути к одной сущности).
  • /orders/{id}/items — позиции заказа: живут только внутри заказа, вложенность честная.
  • Отмена заказа — не DELETE (заказ остаётся в истории), а POST /orders/{id}/cancel.

Маршруты

GET    /v1/orders?status=paid&cursor=...   200
POST   /v1/orders                          201, 422
GET    /v1/orders/{id}                     200, 404
PATCH  /v1/orders/{id}                     200, 404, 409
POST   /v1/orders/{id}/cancel              200, 404, 409

Пагинация cursor-based: у заказов высокая скорость вставки, offset давал бы дубли на границах страниц.

Пример ошибки валидации

HTTP/1.1 422 Unprocessable Entity
{
  "error": {
    "code": "validation_failed",
    "message": "Заказ не прошёл валидацию",
    "details": [{ "field": "items", "code": "min_length", "message": "Минимум одна позиция" }]
  }
}

Открытые вопросы

  • Нужна ли партнёрам фильтрация по датам с таймзоной клиента?
  • SLA на идемпотентный повтор POST /orders — сколько хранить ключи?

Похожие промпты

Программирование и Разработка

Ревью backend-кода: архитектура и безопасность

Проводит ревью серверного кода: слои и границы модулей, работа с БД и транзакциями, обработка ошибок, инъекции и утечки данных — замечания ранжированы, правки «до/после».

Программирование и Разработка

Ревью Next.js-кода: App Router и Server Components

Проводит ревью Next.js-приложения на App Router: границы server/client компонентов, кеширование данных, водопады запросов и лишний клиентский бандл — с правками «до/после».

Программирование и Разработка

SEO-аудит Next.js-приложения

Проверяет Next.js-приложение по SEO-чеклисту: метаданные и canonical, рендеринг для ботов, sitemap/robots, Core Web Vitals — и выдаёт план правок по приоритету.

Программирование и Разработка

Ревью Vue 3 компонентов: Composition API и реактивность

Проводит ревью Vue 3 кода: потерянная реактивность, утечки в composables, перегруженные компоненты и лишние перерендеры — с правками «до/после» и объяснением механики.