|
|
|
This feature generates online documentation
|
|
|
|
This feature generates online documentation. This documentation is available in two versions.
|
|
|
|
|
|
|
|
* /_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.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
## Maven
|
|
|
|
|
|
|
|
<dependency>
|
|
|
|
<groupId>dfki.sds.delight</groupId>
|
|
|
|
<artifactId>docu-delight-feature</artifactId>
|
|
|
|
<version>4.0-SNAPSHOT</version>
|
|
|
|
</depencency> |
|
|
|
<dependency>
|
|
|
|
<groupId>dfki.sds.delight</groupId>
|
|
|
|
<artifactId>docu-delight-feature</artifactId>
|
|
|
|
<version>4.0-SNAPSHOT</version>
|
|
|
|
</depencency> |
