Навыки api-documentation-generator
📚

api-documentation-generator

Безопасно

Генерация профессиональной API документации

Также доступно от: CrazyDubya

Перестаньте писать API документацию вручную и поддерживать её в актуальном состоянии. Этот навык автоматически генерирует исчерпывающую, удобную для разработчиков документацию из вашей кодовой базы с рабочими примерами.

Поддерживает: Claude Codex Code(CC)
📊 70 Адекватно
1

Скачать ZIP навыка

2

Загрузить в Claude

Перейдите в Settings → Capabilities → Skills → Upload skill

3

Включите и начните использовать

Протестировать

Использование «api-documentation-generator». Документировать конечную точку POST /users, которая создает учетные записи пользователей

Ожидаемый результат:

  • ## Создание пользователя
  • Создает новую учетную запись пользователя.
  • Endpoint: POST /api/v1/users
  • Authentication: Требуется (Bearer токен)
  • Request Body: email (обязательно), password (обязательно, мин. 8 символов), name (обязательно)
  • Success Response: 201 Created с объектом пользователя, включая id, email, name, createdAt
  • Error Responses: 400 Ошибка валидации, 409 Email существует, 401 Unauthorized
  • Примеры предоставлены на cURL, JavaScript fetch и Python requests

Использование «api-documentation-generator». Документировать GraphQL запрос GetUser с параметром ID

Ожидаемый результат:

  • ## Запрос пользователя
  • Получает информацию о пользователе по ID.
  • Query: GetUser($id: ID!) возвращает объект пользователя с id, email, name, role, posts
  • Variables: id (обязательно, тип ID)
  • Response: Объект data, содержащий пользователя с вложенным массивом posts
  • Errors: USER_NOT_FOUND с кодом расширения и userId

Аудит безопасности

Безопасно
v1 • 2/24/2026

This skill is a documentation generator that produces API documentation from codebases. Static analysis flagged 65 external_commands and 12 network patterns, but all are FALSE POSITIVES. The SKILL.md file contains only instructional markdown with code examples formatted using markdown backticks (not shell execution). URLs are documentation examples (api.example.com), not actual network calls. No executable code, no cryptographic implementations, and no system commands exist. Safe for publication.

1
Просканировано файлов
487
Проанализировано строк
0
находки
1
Всего аудитов
Проблем безопасности не найдено
Проверено: claude

Оценка качества

38
Архитектура
100
Сопровождаемость
87
Контент
21
Сообщество
100
Безопасность
91
Соответствие спецификации

Что вы можете построить

Документация REST API

Генерирует полную документацию конечных точек для REST API с примерами запросов/ответов, деталями аутентификации и кодами ошибок

Документация схемы GraphQL

Создает документацию по запросам и мутациям со спецификациями переменных, структурами ответов и форматами ошибок

Контент портала разработчика

Создает исчерпывающую справочную документацию API, включая руководства по началу работы, настройку аутентификации и рекомендации по использованию

Попробуйте эти промпты

Базовая документация конечной точки 
Документируйте эту конечную точку API: [paste code]. Включите HTTP метод, URL путь, параметры запроса, формат ответа и один пример кода.
Полная справка API 
Сгенерируйте полную документацию API для этой кодовой базы: [paste files]. Включите все конечные точки, требования аутентификации, схемы запросов/ответов, коды ошибок и примеры кода на cURL, JavaScript и Python.
Генерация спецификации OpenAPI 
Преобразуйте этот код API в спецификацию OpenAPI 3.0: [paste code]. Включите все пути, компоненты, схемы безопасности и значения примеров.
Обновление документации по изменениям кода 
Обновите документацию API на основе этих изменений кода: [show diff]. Определите новые конечные точки, измененные параметры и измененные форматы ответов. Предоставьте обновленные разделы документации.

Лучшие практики

  • Храните документацию близко к коду, используя комментарии или аннотации для обеспечения синхронизации
  • Включайте рабочие примеры кода, протестированные на песочнице или staging окружении
  • Документируйте все коды ошибок и крайние случаи, а не только сценарии успеха

Избегать

  • Написание примеров документации с данными-заполнителями вроде foo и bar вместо реалистичных значений
  • Документирование только сценариев успешного выполнения без охвата обработки ошибок
  • Создание документации как отдельного артефакта, который забывается при изменениях кода

Часто задаваемые вопросы

Какие языки программирования поддерживает этот навык?
Этот навык может документировать APIs, написанные на любом языке. Он генерирует примеры документации на cURL, JavaScript, Python и других языках по мере необходимости.
Может ли это генерировать спецификации OpenAPI/Swagger?
Да. Предоставьте свой код API, и этот навык сгенерирует действительный файл спецификации OpenAPI 3.0, который можно использовать с Swagger UI или аналогичными инструментами.
Проверяет ли этот навык задокументированные конечные точки?
Нет. Этот навык генерирует документацию из анализа кода, но не выполняет и не проверяет конечные точки. Тестируйте примеры в вашем staging окружении.
Может ли это документировать GraphQL APIs?
Да. Этот навык документирует GraphQL запросы, мутации и подписки со спецификациями переменных, структурами ответов и форматами ошибок.
Как поддерживать документацию в актуальном состоянии при изменениях API?
Запустите этот навык снова с вашим обновленным кодом. Для лучших результатов интегрируйте генерацию документации в ваш CI/CD пайплайн.
Может ли это создавать коллекции Postman?
Да. Этот навык может генерировать JSON файлы коллекций Postman, которые включают все задокументированные конечные точки с примерами запросов.

Сведения для разработчиков

Автор

sickn33

Лицензия

MIT

Репозиторий

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation-generator

Ссылка

main

Структура файлов

📄 SKILL.md