Files
hawkbit/hawkbit-rest/hawkbit-rest-docs
Kai Zimmermann d8ad9f6ef0 Sandbox uri and user includes DEMO hint (#692)
* New sandbox name und users.

* Fix controllerId in DDI docs.

* Optimise README set new creds

* Revert accidental checkin

* Fix typo.

* Cleanup text.

* Merge
2018-06-06 16:52:34 +02:00
..

hawkBit Rest Documentation tests

The hawkBit Rest Documentation tests are based on Rest Docs. These tests generate documentation for our RESTful services.

Run and create snippets

Run the test with maven

mvn clean package

Every rest test will create snippets (e.g. curl-request.adoc, http-request.adoc) in the target\generated-snippets\ directory.

Use the snippets

The snippets get included using Asciidoc within our API documents in src\main\asciidoc. Those documents in turn are used to generate HTML documents in the target\classes directory when building with maven.