Retour aux prompts
ClaudeAvancéIT
Rédiger une spécification technique d'API REST
Prompt
0 utilisations<api>
Nom : {{NOM_API}}
Objectif : {{OBJECTIF}}
Ressources principales : {{RESSOURCES}}
Authentification : {{AUTH_TYPE}} (JWT / API Key / OAuth2)
</api>
<tâche>
Rédige une spécification technique complète :
1. **Vue d'ensemble** — Objectif, base URL, versioning
2. **Authentification** — Mécanisme détaillé avec exemples
3. **Endpoints** — Pour chaque ressource :
- Method + URL
- Paramètres (path, query, body) avec types et validation
- Réponse (structure JSON, codes HTTP)
- Exemple de requête et réponse
4. **Gestion d'erreurs** — Format standard, codes d'erreur custom
5. **Rate limiting** — Limites et headers
6. **Pagination** — Mécanisme (cursor / offset)
7. **Webhooks** — Si applicable
Format OpenAPI/Swagger-like. Prêt pour l'implémentation.
</tâche>