AIKraft/AI/Войти
AIKraft/Skills/Генератор документации api

Генератор документации api

Generates API documentation using OpenAPI/Swagger specifications with interactive documentation, code examples, and SDK generation. Use when users request

patricio0312rev official Документы

Что делает навык

Навык генерирует комплексную документацию API на основе спецификаций OpenAPI/Swagger, включая интерактивные интерфейсы, примеры кода и клиентские библиотеки (SDK). Он решает задачу создания стандартизированной и удобной для использования документации, автоматически формируя спецификации, схемы данных и примеры запросов/ответов.

Когда применять

  • Генерация интерактивной документации API с использованием Swagger UI для развертывания в веб-приложении.
  • Создание спецификации OpenAPI 3.1.0 из существующего кода Express/Node.js с помощью библиотеки express-openapi.
  • Автоматическое преобразование схем валидации Zod в формат OpenAPI с помощью пакета @asteasolutions/zod-to-openapi.
  • Создание клиентской библиотеки (SDK) для упрощения интеграции с API.

Как работает

  1. Проанализировать API-эндпоинты: изучить маршруты, HTTP-методы и параметры.
  2. Определить структуру спецификации OpenAPI, указав метаданные, серверы, теги и схемы безопасности.
  3. Описать пути (paths) для каждого эндпоинта, включая методы, параметры, запросы и примеры ответов.
  4. Создать компоненты (components): определить схемы данных (schemas), параметры, ответы и схемы аутентификации.
  5. Настроить интеграцию с инструментами визуализации, такими как Swagger UI, для развертывания интерактивной документации.
  6. При необходимости сгенерировать SDK или использовать библиотеки вроде express-openapi для извлечения спецификации из кода.

Примеры запросов агенту

Создай спецификацию OpenAPI для API управления пользователями с эндпоинтами CRUD и аутентификацией через Bearer token.
Настрой Swagger UI для Express-приложения, чтобы документация была доступна по пути /docs.
Сгенерируй схему OpenAPI из Zod-схем для валидации данных пользователей.

Что понадобится

  • Среда выполнения Node.js с установленными пакетами express, swagger-ui-express, yamljs, openapi-types.
  • Для работы с Zod: пакет @asteasolutions/zod-to-openapi.
  • Для генерации из кода: библиотека express-openapi.

Описание составлено по SKILL.md навыка, сверено 05.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «api-docs-generator» из репозитория: # https://github.com/patricio0312rev/skills
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r api-docs-generator/ ~/.claude/skills/api-docs-generator/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.