API Documentation Template

This template helps you generate comprehensive API documentation that follows industry best practices. It ensures consistency across your API documentation and includes all essential elements that developers need.

Sample Prompt

Generate comprehensive API documentation for:

POST /api/users/register

Include:
- Description and purpose
- Parameters and types
- Request/response examples
- Error codes and messages
- Usage examples
- Rate limiting info

What This Template Covers

• Clear endpoint descriptions with purpose and context
• Complete parameter documentation including types, requirements, and validation rules
• Request and response examples in multiple formats (JSON, XML, etc.)
• Error handling with comprehensive error codes and messages
• Authentication requirements and security considerations
• Rate limiting information and usage quotas
• SDK examples in popular programming languages

Best Practices

1. Use consistent formatting across all endpoint documentation
2. Include real-world examples rather than placeholder data
3. Document edge cases and error scenarios
4. Provide code samples in multiple languages
5. Keep authentication requirements clear
6. Update documentation with every API change
7. Include versioning information for API endpoints

When to Use This Template

• Creating documentation for new API endpoints
• Standardizing existing API documentation
• Onboarding new developers to your API
• Preparing for API reviews or audits
• Building comprehensive developer portals

The Script

peep api-documentation