Swagger to notebook to microservice

[parente]

Demonstrate turning a Swagger spec into kernel-based microservice. Include:

• Code that turns a Swagger API spec into a template notebook with annotations for the kernel gateway
• A notebook with the template completely implemented
• A Dockerfile that packages the necessary kernel, kernel gateway, and notebook together and starts a single instance of the microservice on Docker run

[parente]

/cc @Lull3rSkat3r

[parente]

Discussed on appear. We're going to axe the user permissions and auth from the pet store example since it starts to conflate microservice with web app backend.

We're going to put in the PR without the error codes and headers to get a MVP in. We'll keep this open to keep improving it over time.

[parente]

Tried the instructions today. Worked fine. Good work.

Other than the API completion that we talked about, what's missing is a separate UI so folks can understand how the microservice can be used. I really don't want to implement a whole pet store web site, but we have to have something that demonstrates how notebook-to-microservice = backend that can then be used to develop a frontend (be it by coding one or using some dashboarding tool).

I have no thoughts at the moment other than "write something simple ourselves". Any ideas?

[Lull3rSkat3r]

So a few ideas (in order of what I think is best):

1. The swagger-codegen module can generate a static web page for interacting with an API. We could generate this file in the gen target and add it as a parameter to the gateway to serve that file
2. http://editor.swagger.io - I have included the swagger yaml and json files for the demo. They can be used to import into the swagger editor and that will generate a UI dynamically. I did a quick test and there are some CORS issue we would need to handle.
3. On a similar note as the two points above, the swagger-ui project renders a page which can point to a swagger spec. This would require us to finish shutdown_all does not check VALIDATE_KG_CERT #42 and would actually lose data about the spec since we don't support all the swagger features in our parsing of the notebook.
4. I have a bunch of postman requests which interact with the server for testing. We could pretty them up and use that as a demo (you can import collections of requests into postman

[parente]

#1 sounds fine for this demo. How about just bringing it up in a second container along side the first microservice one and telling people to point their browsers at it?

[Lull3rSkat3r]

Brining up another container would result in the CORS issues I was seeing in the second point.

[parente]

We decided to enable the CORS headers in kernel gateway over notebook-http mode. That way we can use the public editor.swagger.io.

[parente]

We enabled the CORS headers in the kernel gateway for notebook-http mode. This now works as expected on editor.swagger.io. Closing.