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 rate limiting
Protect APIs from abuse
Prompt DALL-E to Create a Prototype
Creating visual prototypes is a crucial step in any product design process. Traditionally reserved for designers with specialized tools like Figma or Sketch, this phase can now be accelerated with DALL-E. By generating realistic visual mockups from text descriptions, DALL-E allows entrepreneurs, product managers, and developers to quickly materialize their ideas without advanced graphic skills. Whether you want to visualize a mobile app interface, a physical product, or an architectural concept, DALL-E transforms your descriptions into compelling visual representations. This approach considerably reduces the time between ideation and the first visual iteration, going from several days to a few minutes. The AI-generated prototype then serves as a basis for discussion with stakeholders, investors, or potential users, facilitating the collection of concrete feedback before investing in costly development. Mastering the art of prompting for prototype generation with DALL-E thus becomes a strategic skill for anyone wishing to innovate quickly and effectively.
GitHub Copilot Prompt for Creating E2E Tests
End-to-end (E2E) tests are essential for validating the overall functionality of an application, but writing them is often time-consuming and repetitive. GitHub Copilot, integrated directly into your code editor, can significantly speed up this process by generating comprehensive test scenarios from natural language descriptions. Whether you use Playwright, Cypress, or Selenium, Copilot understands the context of your project—components, routes, selectors—to produce realistic and maintainable tests. The challenge is to craft prompts precise enough to obtain tests that cover critical user journeys, handle wait states and assertions robustly, while respecting your testing framework's best practices. In this guide, you will find an optimized main prompt as well as variants adapted to your experience level to get the most out of GitHub Copilot in creating your E2E tests.
Create Database Seed Data
Generate realistic test data for development