Напиши документацию для API endpoint
Превращает код и контракт endpoint в понятную техническую документацию: назначение, параметры, запрос, ответы и ошибки без выдуманных полей.
1 Готовый промпт
Выступи в роли технического писателя и разработчика API.
Endpoint или код:
"""
[HttpPost("/api/tasks")]
public async Task<IActionResult> Create(CreateTaskRequest request) { if (!ModelState.IsValid) return BadRequest(ModelState); ... return CreatedAtAction(...); }
"""
Дополнительный контракт:
"""
CreateTaskRequest: Title — обязательная строка; ProjectId — обязательный int.
"""
Подготовь документацию в следующей структуре:
1. Назначение endpoint.
2. HTTP-метод и маршрут.
3. Авторизация, только если она явно указана.
4. Path/query параметры с типами и обязательностью.
5. Тело запроса с описанием полей.
6. Пример корректного запроса.
7. Успешный ответ с примером.
8. Возможные ошибки и статус-коды, только подтверждённые кодом или контрактом.
9. Короткие замечания по использованию, если они действительно нужны.
Не придумывай поля, коды ошибок, ограничения или права доступа. Если контракт неполный, пометь неизвестные места как требующие уточнения.
Как использовать
Вставьте код endpoint или его контракт. Если есть DTO и известные ответы, добавьте их в дополнительный контекст.
2 Настроить под себя
Заполните понятные поля ниже. Сервис автоматически соберёт новую версию промпта под вашу задачу.
3 Результат настройки
Заполните конструктор выше,
и здесь появится готовый промпт.
4 Примеры результата
Текстовый пример
### POST /api/tasks Создаёт новую задачу. Тело запроса: - `title` — string, обязательно - `projectId` — integer, обязательно Успешный ответ: `201 Created` Возможные ошибки: `400 Bad Request` — если модель не прошла валидацию. Неясно: требуется ли авторизация — в предоставленном фрагменте это не указано.
5 Комментарии
0