maestro icon indicating copy to clipboard operation
maestro copied to clipboard

Published 20 hours ago • verified publisher icon INTO-CPS-Association

Document the web-api

Open CThuleHansen opened this issue 3 years ago • 0 comments

It is possible to document the web-api directly in code. Example: https://github.com/INTO-CPS-Association/maestro/blob/development/maestro-webapi/src/main/java/org/intocps/maestro/webapi/maestro2/Maestro2SimulationController.java#L215-L217

which is outputted as: image

Same can be carried out for data within the java json representation: https://github.com/INTO-CPS-Association/maestro/blob/bbad8416aa019cd2ed6bc79089a43731cb30077c/maestro-webapi/src/main/java/org/intocps/maestro/webapi/maestro2/dto/SimulateRequestBody.java#L11-L12

Outputted as: image

CThuleHansen avatar May 07 '21 08:05 CThuleHansen