subutai-io / cdn

Gorjun is a golang replacement for Kurjun project.
Apache License 2.0
19 stars 13 forks source link

Swagger/OpenAPI specification for Gorjun #153

Open akarasulu opened 6 years ago

akarasulu commented 6 years ago

This is really nice stuff to have to describe the Gorjun REST interface. In fact, we need to do this for all REST interfaces in Subutai. The Gorjun API is small and a great example project to write a spec for. Here's a really nice tutorial to start doing something like this:

https://apihandyman.io/writing-openapi-swagger-specification-tutorial-part-1-introduction/

akarasulu commented 6 years ago

Use this to generate drivers for Java, Golang, Javascript, and Ruby: https://github.com/Azure/autorest

akarasulu commented 6 years ago

Please quickly just produce a simple specification with a few of the REST operations for testing. See if we can produce some golang and java library from it using this autorest. Then report back here.