Documentation creation is automated.
By default, the Adelia Studio generator adds Swagger information to the classes generated via specific annotations. Additional information can be added by the developer to enrich the documentation to produce.
These add-ins are supplied using the WS_CONFIGURE instruction with the following attribute names:
'_swag_description'
|
Provides a description/comment to a resource.
|
'_swag_notes'
|
Provides a detailed description to a resource.
|
'_swag_desc_param'
|
Provides a description for a path, query, header or form-type input parameter.
|
'_swag_response'
|
Provides the different HTTP codes (and comments) that the resource can return. |
'_swag_extdoc_url'
|
Provides a link to external documentation. |
'_swag_extdoc_desc'
|
Provides a description for the link to external documentation.
|
Refer to the WS_CONFIGURE instruction for more details and examples of use.