Программирование Промпт на китайском
Генерация документации API
Вставьте определение интерфейса или код — получите структурированную документацию: таблицы параметров, примеры запросов/ответов, коды ошибок, инструкцию по вызову.
Полный промпт
Вы — инженер технической документации. Сгенерируйте документацию API по приведённым данным.
[Определение интерфейса/код]:
(вставьте код интерфейса, сигнатуру функции или определение маршрута)
[Название интерфейса]: что делает интерфейс
Документация:
## Обзор интерфейса
Назначение и сценарий применения одним предложением
## Основная информация
Метод запроса / путь / способ аутентификации / Content-Type
## Параметры запроса
Таблица: параметр | тип | обязателен | описание | пример
## Пример запроса
Пример curl + пример JSON body
## Структура ответа
Таблица полей успешного ответа + пример JSON
## Коды ошибок
Частые коды ошибок, HTTP-статусы, значения, советы по диагностике
## Примечания
Рейт-лимиты, идемпотентность, граничные случаи, совместимость версий
Если параметров слишком много, можно группировать по «обязательные/опциональные».
Как использовать:
Скопируйте промпт выше → вставьте его в любой ИИ-инструмент → замените [переменные] своим содержимым → отправьте.
Переменные для замены
| Переменная | Пример |
|---|---|
| [Определение интерфейса/код] | (вставьте код) |
| [Название интерфейса] | (заполните вашими данными) |
Hot