api-documentation-generator
Générer la documentation OpenAPI à partir des routes API
也可从以下获取: sickn33
Créer une documentation API manuellement prend des heures de travail. Cette skill analyse automatiquement les fichiers de routes Express, FastAPI, NestJS, Flask et Rails pour générer des spécifications OpenAPI 3.0 complètes avec des schémas, des paramètres et des réponses.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“api-documentation-generator”。 Générer la documentation OpenAPI pour mes routes API Express
预期结果:
- Généré openapi.yaml avec 12 points de terminaison répartis sur 3 balises
- Schémas créés : User, CreateUserRequest, Product, Order
- Schémas d'authentification ajoutés : BearerAuth (JWT) et ApiKeyAuth
- Réponses d'erreur incluses : 400, 401, 404, 500
- Sauvegardé dans : /project/openapi.yaml
正在使用“api-documentation-generator”。 Créer la documentation API pour mon backend FastAPI
预期结果:
- Analysé 8 points de terminaison dans routes/users.py et routes/products.py
- Extraits les modèles Pydantic pour UserResponse, ProductCreate
- Généré une spécification OpenAPI 3.0 avec les paramètres de pagination
- Ajouté les définitions de réponses d'erreur 401 et 422
安全审计
安全This is a prompt-based documentation skill with no executable code. It provides instructions for generating OpenAPI documentation and includes template files and examples. All static findings are false positives triggered by documentation patterns (HTTP method names, API endpoint syntax, and security concept references). No network access, no file system manipulation beyond normal AI operations, and no data collection.
风险因素
⚙️ 外部命令 (38)
质量评分
你能构建什么
Documenter les API REST
Générer automatiquement des spécifications OpenAPI à partir des définitions de routes Express, FastAPI ou NestJS pour les consommateurs d'API.
Créer une documentation de référence API
Transformer les fichiers de routes du codebase en documentation prête pour Swagger UI sans écrire manuellement de spécifications.
Générer des contrats API
Créer des spécifications OpenAPI standardisées pour les configurations de passerelle API et les tests d'intégration.
试试这些提示
Utiliser la skill API Documentation Generator pour analyser mes routes Express et générer un fichier openapi.yaml à la racine du projet.
Utiliser la skill API Documentation Generator pour lire mes points de terminaison FastAPI et améliorer la documentation OpenAPI auto-générée avec des exemples supplémentaires et des réponses d'erreur détaillées.
Utiliser API Documentation Generator pour trouver toutes les routes API dans mon codebase, incluant les routes Express dans le dossier backend et les API Flask dans le répertoire api, puis générer une spécification OpenAPI unifiée.
Générer une documentation OpenAPI 3.0 complète pour mon API REST. Inclure tous les points de terminaison découverts, les schémas de requête/réponse, les exigences d'authentification, et les regrouper par les balises Users, Products et Orders.
最佳实践
- Exécuter la skill après l'ajout de nouveaux points de terminaison pour maintenir la documentation à jour
- Vérifier les schémas générés par rapport au comportement réel de l'API avant la publication
- Ajouter des commentaires JSDoc ou des docstrings aux routes pour des descriptions de points de terminaison plus riches
避免
- Utiliser la documentation générée sans vérifier la précision des réponses
- Sauter la configuration du schéma de sécurité pour les points de terminaison authentifiés
- Générer une documentation sans avoir accès aux fichiers source des routes