API Documenter
Générer la documentation API
Les développeurs passent des heures à rédiger manuellement la documentation API. Cette compétence automatise la création de documentation API complète à partir de code ou de spécifications OpenAPI, faisant gagner du temps et assurant la cohérence.
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 Documenter". Générer la documentation API pour un endpoint GET /users/{id} qui retourne les données du profil utilisateur
Résultat attendu:
- # GET /users/{id}
- Récupère un profil utilisateur par identifiant unique.
- ## Requête
- - Méthode: GET
- - Chemin: /users/{id}
- - Auth: Jeton Bearer requis
- ## Réponse 200
- ```json
- {"id": "user_123", "name": "John Doe", "email": "john@example.com"}
- ```
Utilisation de "API Documenter". Documenter cette spécification OpenAPI pour une API d'animaux
Résultat attendu:
- # API Pet Store
- ## Présentation
- API RESTful pour gérer l'inventaire des animaux.
- ## Endpoints
- - GET /pets - Liste des animaux
- - POST /pets - Ajouter un animal
- - GET /pets/{id} - Obtenir un animal
- - DELETE /pets/{id} - Supprimer un animal
Audit de sécurité
SûrThis is a prompt-only skill that generates API documentation. Static analysis found no executable code, no network requests, no filesystem access, and no external command execution. The skill contains only natural language prompts for generating documentation content.
Score de qualité
Ce que vous pouvez construire
Documentation API rapide pour les services internes
Générer rapidement de la documentation pour les microservices internes pendant les sprints de développement
Documentation API publique
Créer une documentation soignée pour les produits API publics
Récupération de documentation API héritée
Générer de la documentation pour les API héritées non documentées en analysant le code
Essayez ces prompts
Générer la documentation API pour l'endpoint suivant: [coller le code ou la description de l'endpoint]
Créer une documentation API complète pour cette spécification OpenAPI: [coller le JSON/YAML OpenAPI]
Générer la documentation API avec des exemples de code en Python, JavaScript et curl pour: [coller les détails de l'endpoint]
Créer une documentation API markdown soignée avec des sections pour la présentation, les endpoints, l'authentification, les codes d'erreur et les exemples: [coller la spécification API]
Bonnes pratiques
- Fournir des spécifications OpenAPI complètes pour de meilleurs résultats
- Inclure les détails d'authentification dans l'entrée
- Vérifier l'exactitude des exemples générés avant publication
Éviter
- S'attendre à des tests en direct des endpoints API
- Fournir des descriptions d'endpoint incomplètes ou ambiguës
- Supposer que la compétence connaît vos conventions internes spécifiques