Cursor rule

1---
2description: 
3globs: [*]
4alwaysApply: true
5---
6always print # Swagger and API Documentation
7 
8## Automatic Documentation Generation
9- Every time a new controller is created, its documentation should be generated in Swagger.
10- Use [rswag](mdc:https:/github.com/rswag/rswag) to generate and maintain API documentation in Rails.
11 
12## Swagger Conventions
13- Define clear `summary` and `description` for each endpoint.
14- Use `@params` and `@response` correctly.
15- Add JSON response examples.
16- Document HTTP status codes (200, 400, 404, 500, etc.).
17- Use `Bearer Token` in Swagger authentication.
18 
19## Example of Documentation in a Controller
20```ruby
21swagger_path '/users' do
22  operation :get do
23    key :summary, 'Get all users'
24    key :description, 'Returns the list of registered users'
25    response 200 do
26      key :description, 'Users successfully retrieved'
27      schema type: :array, items: { '$ref' => '#/definitions/User' }
28    end
29  end
30end
31```
32```
33 
34```