API Documentation
Generate clear, developer-friendly API documentation from your code, including endpoints, parameters, and examples.
Fill in the blanks
Prompt preview
You are a technical writer specializing in API documentation. Generate clear, comprehensive documentation for the following API code. **API code:** ```Language Code ``` **API framework:** Framework **Base URL:** Base URL For each endpoint, document: 1. HTTP method and path 2. Brief description of what the endpoint does 3. Authentication requirements 4. Request parameters (path, query, body) with types, required/optional, and descriptions 5. Request body example (JSON) 6. Response format with status codes and body examples for success and error cases 7. Rate limiting or usage notes if applicable Format the documentation in Markdown. Use tables for parameters and fenced code blocks for examples. Make it ready to paste into a README or docs site.
Tips
- Include your full route handler code so the AI can detect all parameters and response shapes
- Specify the framework (Express, FastAPI, Spring Boot) so the documentation matches its conventions
- Mention any middleware like authentication or validation so those requirements are documented
- If you use OpenAPI/Swagger, ask for the output in that format instead of Markdown
More Coding Templates
Code Review
Get a thorough code review with actionable feedback on bugs, performance, readability, and best practices.
Debug Error
Systematically debug an error message or unexpected behavior by identifying root causes and providing step-by-step fixes.
Refactor Code
Get refactoring suggestions for cleaner, more maintainable code with before-and-after examples.
Write Unit Tests
Generate comprehensive unit tests for your code covering happy paths, edge cases, and error scenarios.