Design a complete REST API
Design a robust and well-structured REST API with OpenAPI documentation, error handling and security best practices.
Paste in your AI
Paste this prompt in ChatGPT, Claude or Gemini and customize the variables in brackets.
Tu es un architecte API senior spécialisé dans la conception d'APIs RESTful. Je dois concevoir une API pour [DESCRIPTION_DU_SYSTÈME] qui sera utilisée par [TYPE_DE_CLIENTS: ex. applications mobiles, partenaires tiers, frontend React]. **Ressources principales à gérer :** [LISTER_LES_RESSOURCES: ex. Utilisateurs, Produits, Commandes, Paiements] **Contraintes techniques :** - Backend : [EX: Node.js/Express, Python/FastAPI, Go] - Authentification : [EX: JWT, OAuth2, API Key] - Volume estimé : [EX: 10 000 requêtes/jour] - Versions à supporter : [EX: v1 uniquement, ou v1 + v2] Conçois une API REST complète en couvrant : 1. **Structure des endpoints** : liste tous les endpoints CRUD pour chaque ressource avec leur méthode HTTP, chemin, paramètres et codes de réponse. 2. **Authentification et autorisation** : détaille le flux d'authentification et les règles de permission par endpoint. 3. **Conventions de nommage** : définis les règles de nommage pour les ressources, paramètres et réponses. 4. **Gestion des erreurs** : propose un format de réponse d'erreur standardisé avec des codes d'erreur métier. 5. **Pagination et filtrage** : définis la stratégie de pagination et les paramètres de filtrage/tri. 6. **Documentation OpenAPI** : génère le fichier swagger.yaml pour les 3 endpoints les plus importants. 7. **Bonnes pratiques de sécurité** : rate limiting, validation des entrées, CORS, headers de sécurité.
Why this prompt works
<p>This prompt guides the AI through all the architectural decisions of a professional REST API. By specifying resources and constraints from the start, we get a coherent and realistic design rather than a generic example.</p><p>The request for a partial OpenAPI file is particularly valuable because it forces the concretization of conceptual decisions into an executable specification that frontend and backend teams can use immediately.</p><p>The inclusion of security aspects (rate limiting, CORS, headers) in the initial design rather than as an afterthought reflects Security by Design best practices, reducing the risks of vulnerabilities introduced during late additions.</p>
Use Cases
Expected Output
A complete API specification with endpoints, authentication flows, error format, pagination strategy and OpenAPI excerpt.
Learn more
Check the full skill on Prompt Guide to master this technique from A to Z.
View on Prompt GuideGlossary Terms
Similar Prompts
Learn the basics of Git for beginners
Learn Git from scratch with illustrated explanations, concrete examples, a practical workflow and a cheatsheet of essential commands.
Define a Git strategy for a team
Define a comprehensive Git strategy adapted to your team: branching model, conventions, code review and release management.
Configure a CI/CD pipeline with GitHub Actions
Configure a professional CI/CD pipeline with GitHub Actions covering testing, security, Docker build and multi-environment deployment.
Write integration tests for an API
Create comprehensive API integration tests with database setup, authentication, CRUD and end-to-end scenarios.