# Контракт API — промпт для ChatGPT

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

Канонический адрес: https://boswidget.ru/prompt/kontrakt-api/

Модель: ChatGPT

Категория: Код

Теги: API, контракт, документация

![Контракт API](https://boswidget.ru/assets/images/text-preview-chatgpt-api-contract-1200.851d941134c6.webp)

Контракт API

## Промпт

Подготовь черновик контракта HTTP API для задачи: {task}. Согласованные правила и данные: {rules}. Дай метод и путь, таблицы полей запроса и ответа с типами, обязательностью и ограничениями, один пример успешного ответа и варианты ошибок. Разделяй согласованное и предложенное. Не добавляй персональные данные без необходимости, секреты и реальные токены. В конце перечисли решения, которые нужно согласовать до реализации. Проверь, что примеры соответствуют указанным типам.

## Поля шаблона

- `{task}` — Задача метода. Пример ввода: Что должен сделать клиент и какой результат получить
- `{rules}` — Правила и данные. Пример ввода: Поля, ограничения, доступ и известные ошибки

## Запуск

[Открыть ChatGPT в YesAI](https://yesai.su/ru/chatgpt)