Files

Natalia Kislicyn eaf6be8c94 Fix output folder for REST docu tests (#1109 )

* Fix output folder for REST docu tests

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>

* Add description to abstract method

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>

2021-04-09 12:24:20 +02:00

src

Fix output folder for REST docu tests (#1109 )

2021-04-09 12:24:20 +02:00

pom.xml

JUnit5 support (#1063 )

2021-02-12 08:22:26 +01:00

README.md

hawkBit rest docs (management & DDI API) (#688 )

2018-05-24 16:10:01 +02:00

README.md

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.