Specify and implement API using Open API 3 (Swagger)

changed title from Specifiy and implement API using Open API 3 (Swagger) to Specify and implement API using Open API 3 (Swagger)

added To Do label

added P3 label

added 1 deleted label

mentioned in issue #21 (moved)

I will create the Open API 3.0 description and then hand it over to @equinox to integrate in the tank with a swagger ui.

changed due date to December 14, 2020

assigned to @jackie

changed due date to December 29, 2020

marked this issue as related to steering#44 (closed)

assigned to @nnrcschmdt and unassigned @jackie

removed due date

removed To Do label

assigned to @robwa and unassigned @nnrcschmdt

added P2 label and removed P3 label

added To Do label

What is our strategy to solve this?

As there is an existing API, I would generate the documentation from the (annotated) code. Another popular approach seems to be, to generate the API code from the documentation.

Here are some libraries which we could use:

• https://github.com/swaggo/swag (but as stated in aura/meta#26 we need OpenAPIv3, swaggo only supports v2)
• https://github.com/getkin/kin-openapi
• https://github.com/getkin/kin-openapi#alternatives
• https://github.com/wI2L/fizz

What do you think? Do you have experiences with one of the libraries?