This feature generates onlinedocumentation. This documentation is available in two versions.
This is a feature creating online-documentation for the running json-over-http delight instance.
* /_api: A list of all registered handlers and the methods provided by them. Special annotations
can be used to augment/modify method descriptions.
*`@Documentation`: prints an extra comment in front of the method signature.
* more?
* /_help: Prints an overview how to use the configured RequestHandler and the registered features.
Also includes the API-section.
### General Help Page
Documentation accepts content negotiation, i.e., by adding a `.txt` or setting the HTTP header `Accept: text/plain`
you can force a plain text description.
This, for example, makes the API description machine-readable.
${ROOT_URL}/_help{.txt,.html}
## Maven
This prints out a summary of things that are supported by the Delight backend. It also prints a summary
of all enabled features and all available service methods.
You can force a plain text version by adding .txt (or by setting `Accept: text/plain`)
### API documentation
${ROOT_URL}/_api{.txt,.html}
Prints out a summary of registered handlers and their provided methods.
Force a text version by adding .txt (or by setting Accept: text/plain).
The text version can serve as machine readable versions used by clients to use/enable the existing API.
Add a `@Documentation` annotation to have an additional description displayed for a method.
An example method description includes the path to the handler method, a possible empty list of parameters along with their names and types, the return type
and an additional description added through the `@Documentation` annotation. The use of `@Polymorph` annotations are also displayed.
