Ce workflow aide les développeurs à créer une documentation API complète en les guidant à travers la création de spécifications OpenAPI, la rédaction de guides développeur, la génération d'exemples de code et la configuration de documentation interactive.
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". Utiliser le workflow @api-documentation pour documenter mon API de gestion des utilisateurs
Résultat attendu:
Je vous guiderai pour créer une documentation API complète en 7 phases :
**Phase 1 : Découverte de l'API**
- Inventaire de vos points de terminaison
- Documentation des formats requête/réponse
- Identification des exigences d'authentification
[Guide à travers chaque phase avec des actions spécifiques]
Utilisation de "api-documentation". Créer une spécification OpenAPI pour mon API e-commerce
Résultat attendu:
Voici la structure de votre spécification OpenAPI :
```yaml
openapi: 3.0.0
info:
title: API E-Commerce
version: 1.0.0
paths:
/products:
get:
summary: Liste les produits
responses:
200:
description: Réponse réussie
```
Audit de sécurité
SûrSecurity analysis confirms this is a safe documentation workflow skill. The static analyzer flagged 28 instances of 'external_commands' (Ruby/shell backtick execution) and 9 instances of 'weak cryptographic algorithms', but both are false positives. The backticks in the file are Markdown code spans (e.g., `api-documenter`) used for skill name references, not shell command execution. No actual security risks were identified.
Problèmes à risque moyen (2)
Score de qualité
Ce que vous pouvez construire
Documentation de nouveau projet API
Créer une documentation complète pour une nouvelle API REST à partir de zéro, incluant les spécifications OpenAPI, le guide développeur et la documentation interactive.
Mise à jour de documentation API existante
Mettre à jour et moderniser la documentation API existante pour inclure les spécifications OpenAPI, les exemples de code et les fonctionnalités interactives d'essai.
Création de portail API interne
Construire un portail API interne avec documentation complète, exemples de code et guides d'intégration pour les équipes internes.
Essayez ces prompts
Utiliser le workflow @api-documentation pour créer la documentation de mon API REST. J'ai une liste de points de terminaison et j'ai besoin d'aide pour générer les spécifications OpenAPI et un guide développeur.
Utiliser @api-documentation pour créer une spécification OpenAPI pour mon API. L'API a une authentification via JWT et inclut les points de terminaison pour les utilisateurs, les produits et les commandes.
Utiliser le workflow @api-documentation pour ajouter des exemples de code à ma documentation API existante. J'ai besoin d'exemples en Python, JavaScript et cURL.
Utiliser @api-documentation pour configurer la documentation interactive avec Swagger UI et Redoc pour ma spécification OpenAPI existante. Configurer la fonctionnalité d'essai.
Bonnes pratiques
- Commencer par la découverte de l'API pour comprendre tous les points de terminaison avant de générer la documentation
- Garder les spécifications OpenAPI synchronisées avec les changements réels de l'API en utilisant l'automatisation
- Tester tous les exemples de code pour garantir qu'ils fonctionnent dans les environnements de production
Éviter
- Sauter la phase de découverte et passer directement à la génération de documentation
- Générer une documentation sans vérifier l'exactitude des spécifications API
- Créer une documentation statique qui n'est jamais mise à jour lorsque les API changent