/
Keeping the REST-doc up to date when adding endpoints

Keeping the REST-doc up to date when adding endpoints

Whenever you add a new REST-endpoint, the REST-documentation needs to be updated.

 

  1. All Path/Query Params and Request Fields must be documented in the JavaDoc of the new endpoint

  2. Compile taskana-rest-spring module

  3. Add a REST-doc test

  4. Add the new generated snippet of that REST-doc test to the rest-api.adoc file

 

Related content

How to properly create a maven module
How to properly create a maven module
Read with this
TODO - Wildfly Application Server configuration
TODO - Wildfly Application Server configuration
More like this
Current Topics
Current Topics
Read with this
Taskana Web Application
Taskana Web Application
More like this
TODO - Security Design
TODO - Security Design
More like this
Spring Boot configuration
Spring Boot configuration
More like this