🌐 API & Integration Documentation Templates
Templates for documenting interfaces and integrations that connect systems together - from REST endpoints to GraphQL queries to external service integrations.
🔗 Available Templates
API Endpoint Template
For REST endpoints, GraphQL, and external APIs
Perfect for documenting:
- REST API endpoints with request/response examples
- GraphQL queries and mutations
- External API integrations
- Authentication and authorization flows
- Error handling and status codes
- Rate limiting and usage guidelines
Use this when you're building or integrating with any kind of API.
🎯 Which Template Should I Use?
| If you're documenting... | Use this template |
|---|---|
| A REST API endpoint | API Endpoint Template |
| A GraphQL query or mutation | API Endpoint Template |
| Integration with external service | API Endpoint Template |
| Authentication flow | API Endpoint Template |
| WebSocket connection | API Endpoint Template |
🚀 Quick Start
- Choose your template from the list above
- Copy the template content from the appropriate file
- Replace the placeholder text with your actual content
- Add request/response examples with real data
- Test all API calls to ensure examples work
📝 API Documentation Standards
All templates follow these principles:
- ✅ Complete examples - working request/response pairs
- ✅ Error scenarios - document what can go wrong
- ✅ Authentication details - clear auth requirements
- ✅ Rate limiting info - usage guidelines and limits
- ✅ Status codes - comprehensive error code documentation
Need help with API documentation? Check out our Documentation Guidelines for more guidance.