API Documentation Generator

Generate clean API documentation from code or specs

🧪 Tested by a human Intermediate 👤 Developer 👤 Tech Lead 👤 Technical Writer
Generate API documentation for [API NAME]. For each endpoint include: (1) HTTP method and path, (2) Description of what it does, (3) Request parameters with types and required/optional, (4) Request body schema with examples, (5) Response schema with examples, (6) Error codes and meanings, (7) Authentication requirements. Format as Markdown.

Works on

🟢 ChatGPT ⭐ Claude (Best)

Copy & Open in

🟢 ChatGPT 🟠 Claude

Prompt is copied to your clipboard when you click

Tips for Best Results

  • Include curl examples for each endpoint
  • Add rate limiting and pagination details
  • Keep descriptions concise — developers scan docs they do not read them

📎 More Prompts

Code Review Assistant

●●
Review this code and provide feedback on: (1) Bugs or logic errors, (2) Security vulnerabilities, (3) Performance issues, (4) Readability and naming, (5) Missing error handling, (6) Test coverage gaps. For each issue: explain the problem, show the fix, and rate severity (critical, important, minor). [PASTE CODE]
🟢 GPT ⭐ Claude

Database Migration Script

●●●
Write a migration script for [CHANGE]. Include: up migration, down migration (rollback), data preservation, validation queries, estimated execution time. Include safety checks.
⭐ M365 🟢 GPT 🟠 Claude

Debug This Error

●●
Debug this error: [PASTE ERROR MESSAGE OR STACK TRACE]. (1) Explain what the error means in plain English, (2) Identify the most likely root cause, (3) Provide a fix with code, (4) Explain why the fix works, (5) Suggest how to prevent this error in the future. Language: [LANGUAGE — Python / JavaScript / C# / PowerShell].
🟢 GPT ⭐ Claude ⚡ M365
💬