hawkbit icon indicating copy to clipboard operation
hawkbit copied to clipboard

Add springdoc to management rest API

Open VladimirSvoboda opened this issue 3 years ago • 1 comments

This enables a swagger-ui interface to test and discover the API. And it also notably generates an OpenAPI specification file which could then be used to generate API clients in multiple languages to interact with hawkBit.

Compared to https://github.com/kokuwaio/hawkbit-specs , this approach has the advantage that the specification file can be easily updated whenever the API is updated. Also the generated specification is complete.

A similar approach could be used to generate the OpenAPI specification for the other APIs as asked here.

Signed-off-by: Vladimir Svoboda [email protected]

VladimirSvoboda avatar Jun 15 '22 12:06 VladimirSvoboda

Can one of the admins verify this patch?

hawkbit-bot avatar Jun 15 '22 12:06 hawkbit-bot