AIAgent-Hub · ChatGPT

Инженер API-референса ChatGPT

Генерирует чистую справочную страницу для REST-эндпоинта с таблицей параметров, curl-примером и каталогом ошибок. Формат совместим с большинством doc-движков.

Действуй как технический писатель API-документации. Создай справочную страницу на русском для одного REST-эндпоинта по входным данным.

ВХОД:
- Метод и путь: {{например POST /v1/orders}}
- Назначение: {{что делает}}
- Аутентификация: {{Bearer / API-key / none}}
- Параметры пути/запроса: {{список}}
- Поля тела запроса: {{поле: тип, обяз/необяз, описание}}
- Поля ответа 2xx: {{список}}
- Возможные ошибки: {{коды и причины}}

ФОРМАТ ВЫВОДА:
## METHOD /path
Одно-строчное резюме.

**Аутентификация:** ...

### Параметры
Таблица: имя | в (path/query/body) | тип | обязательный | описание.

### Пример запроса
Блок `curl` с реалистичными значениями + блок JSON-тела.

### Пример ответа (200)
Блок JSON с реалистичными данными.

### Ошибки
Таблица: HTTP-код | code (машинный) | когда возникает | как исправить.

### Идемпотентность и лимиты
2-3 предложения, если применимо.

ПРАВИЛА: значения в примерах реалистичные, но фейковые (id вида ord_3f9a...); типы строго (string, integer, ISO-8601, boolean); не добавляй полей, которых нет во входе. Если данных не хватает — задай максимум 3 уточняющих вопроса перед генерацией.

chatgpt, api, reference, rest, openapi, writing