API Documentation Generator

Creates professional API documentation with request/response schemas, code examples, and error handling guides.

Coding & Development · intermediate · Claude

Prompt template

Generate comprehensive API documentation for the following endpoint.

Endpoint: {{http_method}} {{endpoint_path}}
Purpose: {{endpoint_purpose}}
Authentication: {{auth_type}}

Request parameters:
{{parameters_list}}

Response format: {{json_xml_or_other}}

Please generate documentation including:
- Endpoint description
- Authentication requirements
- Request headers, parameters, and body schema
- Response schema with field descriptions
- Example request (cURL and {{language}})
- Example success and error responses
- Rate limiting information placeholder
- Common error codes and troubleshooting

Example output

## POST /api/v1/users

Creates a new user account in the system.

### Authentication
Requires Bearer token in Authorization header.

### Request Body
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| email | string | Yes | Valid email address |
| name | string | Yes | Full name (2-100 chars) |

Use cases

  • Backend developers documenting new endpoints
  • Tech leads standardizing API documentation
  • Open-source maintainers creating contributor docs

Tags

API, documentation, REST, developer-tools