Creating RESTful-API documentation with Swagger

[JohannesLichtenberger]

I don't think we can generate it, but maybe "by hand".

[JoelLau]

@JohannesLichtenberger , there're some existing tools available that generate OpenAPI (Swagger) documentation based on code !

See https://github.com/OpenAPITools/openapi-generator.

I believe that works similarly to javadocs. Would you be interested in this ? If not, where should the "hand-written" documentation be stored ?

[JohannesLichtenberger]

I think it works the other way around, right? First, writing the spec and then there are generators to create the respective routes in a framework!?

I've provided a hand written documentation at https://sirix.io/rest-api.html, but I think it needs some additional work. For instance there's a new route GET /database/resource/history with optional parameters startRevision and endRevision which provides revision metadata as for instance the revision number, revision timestamp, author and an optional commit message.

[JohannesLichtenberger]

In any case, thanks so much that you're interested in this task :-)

[vikkihub]

is this task still available?