API Documentation from Code Prompt
Generate endpoint docs with method, auth, request/response schemas, and examples.
Generate API documentation in markdown for the following endpoint code. ```[language] [paste handler / function] ``` Include: - Endpoint URL and HTTP method - Authentication requirements - Request schema with field types and example - Response schema with success and error examples - Error codes and their meanings - Rate limits or idempotency notes - A short description of business logic Format with H3 sections and code blocks.
No pierdas tus mejores prompts en el historial de chats. Guarda prompts directamente desde ChatGPT, Claude y Gemini con la extensión de Marqly, etiquétalos y encuéntralos con búsqueda semántica Pro.
Captura de prompts con un clic · Búsqueda semántica Pro en tu biblioteca · Descubre cómo guardar conversaciones de IA y usar las funciones de captura para tener tus prompts junto a tus fuentes.
How to use this prompt
Paste the smallest relevant code block. Review, test, and lint any generated code before merging; models can hallucinate APIs.
- Copy the full prompt above.
- Replace the bracketed placeholders with your own details.
- Paste it into chatgpt, claude, gemini (or your preferred AI tool).
- Iterate on the output: add constraints, ask follow-ups, or combine multiple results.
Why this prompt works
It gives the AI a clear role, specific inputs, and an output format. That structure reduces vague responses and gives you a draft you can refine in minutes instead of hours.
Preguntas frecuentes
What if the code doesn't show auth logic?
State the assumption and flag the missing auth detail for verification.
Can I generate docs for a whole API?
Yes, but process endpoints one at a time or in small groups for better accuracy.
Last updated:
