Quel est le niveau de difficulté et quel outil IA utiliser ?

Ce prompt est de niveau intermédiaire. Il est compatible avec tous les outils IA (ChatGPT, Claude, Gemini, etc.).

IntermediaireAll AIs

Concevoir une API REST selon les meilleures pratiques

Guide la conception d'une API REST complète et bien structurée, de la définition des endpoints à la documentation OpenAPI, en suivant les standards de l'industrie.

Coller dans votre IA

Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.

Tu es un expert en conception d'APIs REST. Aide-moi à concevoir une API complète pour le besoin suivant.

**Ressource / Domaine métier :** [DOMAINE_METIER] (ex: gestion des commandes e-commerce)

**Utilisateurs de l'API :** [UTILISATEURS_API] (ex: application mobile, partenaires B2B)

**Authentification souhaitée :** [TYPE_AUTH] (JWT, OAuth2, API Key...)

Conçois l'API en couvrant :
1. Liste des endpoints avec verbes HTTP, URLs et descriptions
2. Conventions de nommage et structure des URLs
3. Schémas de requête et réponse (format JSON avec exemples)
4. Codes HTTP retournés par endpoint et leur signification
5. Gestion des erreurs (format standard, codes d'erreur métier)
6. Stratégie de versioning (v1, v2...)
7. Pagination, filtrage et tri pour les listes
8. Rate limiting recommandé
9. Exemple OpenAPI/Swagger pour 2 endpoints clés
10. Liste des pièges REST courants à éviter

Pourquoi ce prompt fonctionne

Le prompt couvre toutes les dimensions d'une API de qualité production. La demande d'exemples JSON concrets évite les réponses trop abstraites. L'inclusion des pièges courants à éviter produit une liste de contrôle qualité intégrée au livrable.