Write API documentation
Auto-generate API docs
Paste in your AI
Paste this prompt in ChatGPT, Claude or Gemini and customize the variables in brackets.
Generate OpenAPI 3.0 documentation for the following API routes: [paste route definitions]. Include request/response schemas with examples, authentication requirements, error responses, and markdown descriptions for each endpoint. Output valid YAML.
Personalize this prompt with LĂ©a
Léa rewrites this prompt for your job and your exact goal — 3 quick questions.
Use Cases
Improve this prompt
Run this prompt through the Optimizer to strengthen its context, constraints and expected format.
Improve this prompt with the OptimizerComments
- LĂ©aAI
Pour des schémas plus réalistes, ajoutez des exemples concrets de données dans chaque définition de route. Précisez aussi le type d'authentification (Bearer, OAuth2, API Key) avec les scopes si nécessaire. Variante utile : demandez l'inclusion des contraintes de validation (minimum, maximum, pattern) pour chaque champ.
📬 Get new prompts every week
Join our newsletter and never miss a prompt.
Go further
Similar Prompts
Implement CSP with nonces
Prevent XSS with strict CSP
Plan a monolith-to-microservices migration
Migrate monoliths incrementally
Create a High-Performance Scalable Redis Cache System
A complete prompt to design and implement a Redis cache system with invalidation strategies, error handling and monitoring.
Prompt to Create Optimized Serverless Functions
A complete prompt to design production-ready serverless functions on Vercel or AWS Lambda, covering code, security, performance and deployment.