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
Answer 3 questions and LĂ©a tailors the prompt to your situation.
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
Prompt ChatGPT to Generate SQL Queries
Generating SQL queries is an essential skill for any developer, data analyst, or database administrator. However, writing complex queries involving multiple joins, nested subqueries, or aggregate functions can be time-consuming and error-prone. ChatGPT transforms this practice radically by allowing you to describe your needs in natural language to obtain optimized and functional SQL queries in seconds. Whether you work with MySQL, PostgreSQL, SQL Server, or SQLite, the AI adapts to the specific syntax of your database management system. By providing your table schema and a clear description of what you want, you can generate perfectly structured SELECT, INSERT, UPDATE, or DELETE queries. ChatGPT also excels at line-by-line explanations of generated queries, making it a valuable learning tool for beginners and professionals alike who wish to explore advanced SQL features like CTEs, window functions, or recursive queries.
Build a virtualized list
Handle massive data lists
E2E Tests with Playwright
Automate testing of critical user journeys
Prometheus Configuration and Alerts
Set up Prometheus monitoring