API Documentation
Generate comprehensive API documentation
Overview
Generate comprehensive API documentation
Use Cases
- Professional coding projects
- Team collaboration and documentation
- Quick content generation with consistent quality
- Automated workflow integration
Template
Generate API documentation for:
Endpoint: {{endpoint}}
Method: {{method}}
Request parameters:
{{requestParams}}
Response format:
{{responseFormat}}
Include:
- Endpoint description
- Authentication requirements
- Request/response examples
- Error codes
- Rate limiting
- Code samples in {{languages}}
Properties
- endpoint: Single-line Text (default:
/api/v1/resource) - method: Single Selection (default:
GET)- Options: GET, POST, PUT, DELETE, PATCH
- requestParams (optional): Multi-line Text
- responseFormat: Multi-line Text
- languages: Multiple Selection (default:
Python, JavaScript, cURL)- Options: Python, JavaScript, TypeScript, cURL, Go, and 2 more