yml_example

Config file

controllers_route: doc/controllers

File example

File route: my_proyect/doc/controllers/users_controller.yml

# =begin resource
description: Represents an user in the system.
# =end

# =begin action
method: GET
action: index
authentication_required: true
response_formats: json
description: Return all users of the system.
  
http_responses:
  - 200
  - 401
  - 403
  - 404
  
params:
  - name: page
    description: number of page in pagination
    required: false
    type: Integer
  
  - name: limit
    description: number of elements by page in pagination
    type: Integer
 
  - name: name
    description: name filter
    type: String
 
  - name: gender
    description: gender filter
    inclusion: male, female
# =end