Документация API
Генерация документации для REST API в формате OpenAPI
Средний0 копирований68 просмотров
Заполните переменные
Значения автоматически подставляются в текст промпта
Промпт
Создай документацию для API:
Эндпоинты:
[описание эндпоинтов]
Формат: OpenAPI 3.0 (YAML)
Для каждого эндпоинта:
1. Путь и метод
2. Описание
3. Параметры (path, query, header)
4. Request body со схемой
5. Responses (200, 400, 401, 404, 500)
6. Примеры запросов и ответов
Дополнительно:
- Общее описание API
- Аутентификация
- Версионирование
- Rate limiting
- Коды ошибок
Пример результата
```yaml
openapi: 3.0.3
info:
title: Users API
version: 1.0.0
description: API для управления пользователями
servers:
- url: https://api.example.com/v1
paths:
/users:
post:
summary: Создание пользователя
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUser'...
Примеры применения
- •API
- •документация
- •OpenAPI