Compétences api-documentation-generator
📚

api-documentation-generator

Sûr

Générer une documentation API professionnelle

Également disponible depuis: CrazyDubya

Arrêtez d'écrire la documentation API manuellement et de la laisser obsolète. Cette compétence génère automatiquement une documentation complète et conviviale pour les développeurs à partir de votre base de code avec des exemples fonctionnels.

Prend en charge: Claude Codex Code(CC)
🥉 74 Bronze
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "api-documentation-generator". Documenter un endpoint POST /users qui crée des comptes utilisateurs

Résultat attendu:

  • ## Créer un utilisateur
  • Crée un nouveau compte utilisateur.
  • Endpoint : POST /api/v1/users
  • Authentification : Requise (token Bearer)
  • Corps de la requête : email (requis), password (requis, min 8 caractères), name (requis)
  • Réponse de succès : 201 Created avec l'objet utilisateur incluant id, email, name, createdAt
  • Réponses d'erreur : 400 Validation Error, 409 Email Exists, 401 Unauthorized
  • Exemples fournis en cURL, JavaScript fetch et Python requests

Utilisation de "api-documentation-generator". Documenter la requête GraphQL GetUser avec le paramètre ID

Résultat attendu:

  • ## Requête utilisateur
  • Récupère les informations utilisateur par ID.
  • Requête : GetUser($id: ID!) retourne un objet utilisateur avec id, email, name, role, posts
  • Variables : id (requis, type ID)
  • Réponse : Objet Data contenant l'utilisateur avec le tableau posts imbriqué
  • Erreurs : USER_NOT_FOUND avec le code d'extension et userId

Audit de sécurité

Sûr
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
Fichiers analysés
487
Lignes analysées
0
résultats
1
Total des audits
Aucun problème de sécurité trouvé
Audité par: claude

Score de qualité

38
Architecture
100
Maintenabilité
87
Contenu
50
Communauté
100
Sécurité
91
Conformité aux spécifications

Ce que vous pouvez construire

Documentation API REST

Générer une documentation complète des endpoints pour les API REST avec des exemples de requête/réponse, les détails d'authentification et les codes d'erreur

Documentation du schéma GraphQL

Créer une documentation des requêtes et mutations avec les spécifications des variables, les structures de réponse et les formats d'erreur

Contenu du portail développeur

Produire une documentation de référence API complète incluant les guides de démarrage, la configuration de l'authentification et les directives d'utilisation

Essayez ces prompts

Documentation de base d'un endpoint 
Documentez cet endpoint API : [collez le code]. Incluez la méthode HTTP, le chemin URL, les paramètres de requête, le format de réponse et un exemple de code.
Référence API complète 
Générez une documentation API complète pour cette base de code : [collez les fichiers]. Incluez tous les endpoints, les exigences d'authentification, les schémas de requête/réponse, les codes d'erreur et des exemples de code en cURL, JavaScript et Python.
Génération de spécification OpenAPI 
Convertissez ce code API en spécification OpenAPI 3.0 : [collez le code]. Incluez tous les paths, composants, schémas de sécurité et valeurs d'exemple.
Mise à jour de la documentation à partir des modifications du code 
Mettez à jour la documentation API en fonction de ces modifications de code : [afficher le diff]. Identifiez les nouveaux endpoints, les paramètres modifiés et les formats de réponse modifiés. Fournissez les sections de documentation mises à jour.

Bonnes pratiques

  • Gardez la documentation proche du code en utilisant des commentaires ou des annotations pour vous assurer qu'ils restent synchronisés
  • Incluez des exemples de code fonctionnels testés contre un environnement de bac à sable ou de staging
  • Documentez tous les codes d'erreur et les cas limites, pas seulement les scénarios de succès

Éviter

  • Écrire des exemples de documentation avec des données génériques comme foo et bar au lieu de valeurs réalistes
  • Documenter uniquement les scénarios de succès sans couvrir la gestion des erreurs
  • Créer la documentation comme un artefact séparé qui est oublié lorsque le code change

Foire aux questions

Quels langages de programmation cette compétence supporte-t-elle ?
Cette compétence peut documenter des API écrites dans n'importe quel langage. Elle génère des exemples de documentation en cURL, JavaScript, Python et d'autres langages selon les besoins.
Peut-elle générer des spécifications OpenAPI/Swagger ?
Oui. Fournissez votre code API et cette compétence générera un fichier de spécification OpenAPI 3.0 valide qui peut être utilisé avec Swagger UI ou des outils similaires.
Cette compétence teste-t-elle les endpoints documentés ?
Non. Cette compétence génère de la documentation à partir de l'analyse du code mais n'exécute ni ne valide les endpoints. Testez les exemples dans votre environnement de staging.
Peut-elle documenter des API GraphQL ?
Oui. Cette compétence documente les requêtes, mutations et subscriptions GraphQL avec les spécifications des variables, les structures de réponse et les formats d'erreur.
Comment garder la documentation à jour lorsque mon API change ?
Exécutez cette compétence à nouveau avec votre code mis à jour. Pour de meilleurs résultats, intégrez la génération de documentation dans votre pipeline CI/CD.
Peut-elle créer des collections Postman ?
Oui. Cette compétence peut générer des fichiers JSON de collection Postman qui incluent tous les endpoints documentés avec des requêtes d'exemple.

Détails du développeur

Auteur

sickn33

Licence

MIT

Dépôt

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

Réf

main

Structure de fichiers

📄 SKILL.md