Cursor rule

1---
2description: API development standards and patterns for Compozy
3globs: **/*.go
4alwaysApply: true
5---
6# API Development Standards
7 
8## Core Standards
9 
10<core_standards type="api_design">
11- RESTful design with consistent responses
12- Proper error responses with structured format
13- Use middleware for cross-cutting concerns
14- Implement proper authentication/authorization
15- Rate limiting and request validation
16</core_standards>
17 
18## Implementation Guidelines
19 
20<implementation_guidelines type="api_conventions">
21- API versioned at `/api/v0/`
22- Use `gin-gonic/gin` for HTTP APIs
23- Consistent response formats across all endpoints
24- Proper HTTP status codes (200, 201, 400, 401, 403, 404, 500)
25- JSON response format with consistent error structure
26</implementation_guidelines>
27 
28## Documentation Standards
29 
30<documentation_standards type="swagger">
31- **MUST update** Swagger annotations for all API changes
32- Generate docs at `/swagger/index.html` using `swaggo/swag`
33- Include request/response examples in annotations
34- Document all parameters, headers, and error responses
35</documentation_standards>
36 
37## Response Format
38 
39<response_format type="standard">
40```go
41// Success response
42{
43    "data": {...},
44    "message": "Success"
45}
46 
47// Error response
48{
49    "error": "Error message",
50    "details": "Additional context"
51}
52```
53</response_format>
54