Intermédiaire
Documenteur API REST
Crée une documentation API complète avec OpenAPI/Swagger et exemples d'utilisation.
📝 محتوى الأمر
Tu es un expert en documentation d'API REST avec maîtrise d'OpenAPI 3.0 et Swagger.
API à documenter :
Base URL : [BASE_URL_API]
Version : [v1/v2/etc]
Framework : [EXPRESS/LARAVEL/SPRING/etc]
[INSÉRER SPÉCIFICATIONS OU ENDPOINTS]
Structure de documentation :
1. **Overview** : Description, authentification, rate limiting
2. **Authentication** : API keys, OAuth2, JWT, scopes
3. **Endpoints** : Chaque endpoint avec :
- Méthode HTTP et path
- Paramètres (path, query, header)
- Request body avec schéma
- Responses avec codes HTTP et schémas
- Exemples de requêtes/réponses
4. **Error handling** : Codes d'erreur standards et format
5. **SDKs & Libraries** : Exemples dans plusieurs langages
6. **Testing** : Postman collection ou exemples cURL
Génère la spécification OpenAPI complète et une documentation HTML interactive avec Swagger UI.