api-documentation
Генерация документации API с примерами
Également disponible depuis: sickn33,supercent-io
Создание полноценной документации API отнимает много времени и часто устаревает. Этот навык автоматически генерирует полную документацию API с примерами, схемами и интерактивными инструментами из вашего кода или спецификаций OpenAPI.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "api-documentation". Сгенерируй документацию API для управления пользователями с аутентификацией
Résultat attendu:
- Полный справочник API со всеми задокументированными endpoints
- Руководство по аутентификации с примерами Bearer token
- Примеры кода на JavaScript, Python, curl и Go
- Инструкции по настройке интерактивного Swagger UI
- Документация по обработке ошибок с кодами состояния
- Руководства по ограничению скорости и пагинации
- Обучающее руководство для начинающих разработчиков
Utilisation de "api-documentation". Создай документацию для REST API с бэкендом на FastAPI Python
Résultat attendu:
- Спецификация OpenAPI, автоматически сгенерированная из docstrings
- Руководство по интеграции FastAPI с автоматической документацией на /docs
- Определения схем запросов/ответов с моделями Pydantic
- Примеры кода на нескольких языках для использования API
- Паттерны обработки ошибок с примерами HTTPException
Utilisation de "api-documentation". Настрой Redoc для существующего API на Express.js
Résultat attendu:
- Конфигурация сервера Express.js для обслуживания Redoc
- Настройка спецификации OpenAPI в формате YAML
- Опции пользовательского оформления и стилизации
- CLI-команды для генерации статического HTML
- Интеграция с docusaurus-plugin-openapi-docs
Audit de sécurité
SûrThis is a documentation-only skill containing markdown guidance and code examples for generating API documentation. All 174 static findings are false positives caused by the analyzer misinterpreting documentation examples as executable code. The skill has no executable code, network calls, file system access, or system command capabilities. The existing skill-report.json already properly assessed this as safe.
Facteurs de risque
🌐 Accès réseau (37)
⚙️ Commandes externes (87)
🔑 Variables d’environnement (7)
Score de qualité
Ce que vous pouvez construire
Автоматическое документирование REST API
Генерация полноценной документации из спецификаций OpenAPI или комментариев в коде с примерами и интерактивными функциями для тестирования.
Настройка порталов для разработчиков
Создание профессиональных сайтов с документацией API с использованием Swagger UI, Redoc или пользовательских шаблонов для внутренних или внешних разработчиков.
Поддержание актуальной документации API
Синхронизация документации с изменениями в коде с помощью автоматической генерации из JSDoc, TypeDoc или docstrings FastAPI.
Essayez ces prompts
Сгенерируй полноценную документацию API из моей спецификации OpenAPI. Включи руководства по аутентификации, примеры кода на JavaScript, Python и curl, документацию по обработке ошибок и инструкции по настройке Swagger UI.
Создай документацию API из моего кода Express.js с комментариями JSDoc. Сгенерируй руководство по началу работы, справочник по endpoints с примерами и инструкции по настройке интерактивной документации.
Спроектируй портал для разработчиков с документацией API, руководством по аутентификации, политиками ограничения скорости, генерацией SDK и интерактивным обозревателем API. Включи примеры на нескольких языках и лучшие практики.
Создай коллекцию Postman из моей документации API с преднастроенными запросами, переменными окружения, тестовыми скриптами и документацией для каждого endpoint.
Bonnes pratiques
- Всегда включайте рабочие примеры кода на нескольких языках программирования
- Четко документируйте требования к аутентификации с примерами
- Поддерживайте синхронизацию документации с изменениями API с помощью автоматизации
Éviter
- Публикация документации без тестирования всех примеров кода
- Пропуск документации по обработке ошибок и граничным случаям
- Использование устаревших инструментов документирования, не поддерживающих OpenAPI 3.0