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.
使用 Marqly 搭建您的专属 AI 提示词库
别再让高效的提示词淹没在聊天历史中。通过 Marqly 浏览器扩展，一键保存 ChatGPT、Claude 和 Gemini 中的优质提示词，并借助 Pro 语义搜索随时调用。
一键采集并收藏提示词 · Pro 级别全库语义搜索 · 了解如何保存 AI 对话内容，并将优质提示词与您的参考资料保存在同一工作区。
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.
常见问题解答
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:
