gologo13 Generate API Documentation
Overview
Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagger specification or following the project's documentation standards.
Steps
- API Overview
- Service description and purpose
- Base URL and versioning information
- Authentication and authorization requirements
- Rate limiting and usage policies
- Endpoint Documentation
- HTTP method and URL path
- Request parameters (path, query, body)
- Request/response schemas with data types
- Example requests and responses
- Possible error codes and messages
- Data Models
- Define all data models and schemas
- Include field descriptions and constraints
- Show relationships between models
- Provide example payloads
- Usage Examples
- Common use case scenarios
- SDK and client library examples
- CURL command examples
- Error handling examples
API Documentation Checklist
- API overview complete
- Endpoints documented
- Data models defined
- Usage examples provided
- Documentation formatted per project standards