The Swagger UI also provides annotations to further customize your documentation.
Listed here is some of the ;documentation to retrieve the todos service:
"/users/{name}/todos": { "get": { "tags": [ "todo-controller" ], "summary": "retrieveTodos", "operationId": "retrieveTodosUsingGET", "consumes": [ "application/json" ], "produces": [ "*/*" ],
As you can see, the documentation generated is very raw. There are a number of things we can improve in the documentation to describe the services better. Here are a couple of examples:
- Provide a better summary
- Add application/JSON to produces
Swagger provides annotations we can add to our RESTful services in order to customize the documentation. ...
