Add API design UI that generates Swagger to Apinf infrastructure

[bajiat]

As an API owner I need a tool that allows me to generate API documentation for my API in Swagger format.

Definition of done

• Choose an UI to generate Swagger documentation
• Implement the chosen tool in Apinf infrastructure.
• Integrate the tool to Apinf UI as simply as possible.

[as33ms]

Trying to put the pieces together:

1. Allow an option for the API owner to generate the Swagger file
   1. Restlet Studio
   2. Swagger Generator (use Swagger UI or Implement own UI)
2. Upload OR obtain the file at the dashboard from above step
3. Show the documentation using the in-built swagger ui implementation

[as33ms]

RestLet studio:

1. Pros
   1. Allows to create a file in design view so a person without any know-how of swagger syntax can create a documentation
   2. Simple to use UI
   3. Supports start from an existing swagger file (if that needs to be updated)
2. Cons
   1. No API to access studio (hence integration only using external links or iframes)
   2. For designing, if forces the design to be done from scratch
   3. OpenSource?

[as33ms]

Swagger UI (internal: swagger-editor)

1. Pros:
   1. Install on our own server
   2. Can get tightly integrated to the dashboard
   3. Allows to import an existing file
2. Cons:
   1. A design view for editor must be developed. Cannot find a solution (other than RestLet) where a design can be done

[as33ms]

Based on discussions with @ccsr, @JuusoV and @ashakunt, we agreed to use Swagger UI. Reasons:

1. Can be tightly coupled with our current system
2. Easier to implement
3. It is also possible to integrate this product to upstream (umbrella ui) if required in future, considering that the whole apiumbreall* product is tightly coupled with Swagger.

IMHO, this is a standard approach.

What should be done next:

• Implementation / integration of swagger editor in the dashboard
• Implement toolbar, something like: [Upload your own | Edit default]
  • Upload your own (upload your existing swagger file)
  • Edit default (swagger-editor opens with a default swagger file which can be edited by the geek)