Implement Swagger viewer as npm module

[bajiat]

Swagger Viewer is currently displayed in iFrame. The solution is very brittle and for example inserting base URL and user's API for making calls through apinf would require a hacky implementation.

The iFrame solution should be replaced by implementing Swagger viewer as npm module.

Definition of done

• Suitable, actively maintained npm package for Swagger UI has been selected
• Package has been integrated into Apinf
• Swagger viewer module is displayed in the same place as the current iFrame solution
• Swagger viewer is only displayed in documentation tab, if a Swagger file has been uploaded for that particular API
• Swagger viewer displays the Swagger file that has been uploaded for the particular API

Candidate npm packages

• swagger-ui
• swagger-ui-lite
• Swagger UI Browserify
• Swagger UI Headless

Example of integrating Swagger UI into templating languages

• Ember Swagger UI

[bajiat]

@brylie Add links to potential npm packages

[brylie]

@bajiat @marla-singer Please see the Candidate npm packages section in the issue description.

@marla-singer feel free to do any research and offer alternative proposals to how we can integrate Swagger UI into our templates without using iframe.

[bajiat]

@brylie Thanks!

[marla-singer]

@brylie Thank you! Has this task any deadline?

[bajiat]

@marla-singer Can you give us your estimate on how long it would take? How many days?

[marla-singer]

@bajiat Today I'm going to study the task more detail and I'll be able give my estimate tomorrow.

[bajiat]

@marla-singer Sounds good to me.

[bajiat]

@marla-singer I removed part of the definition of done. (I thought I had removed it before, but that change didn't actually get updated to Github). The removed part will be in another continuation task. Without removing, your task would be partially blocked by another developer's task. Also, it is best to approach this incrementally.

[marla-singer]

@bajiat Yesterday and today I learnt npm packages and tryed to implement swagger-ui packages in empty meteor project. So I think it needs about 2 days to integrate and setting swagger library to our project plus a day for test and review. My estimate is three days.

[bajiat]

@marla-singer Thanks for the estimate! What is the current status of the task?

[marla-singer]

@bajiat Current status is setting of css and fix to show button 'Authorize'

[preriasusi]

#1490 @marla-singer Is it possible to control Swagger UI launch settings while starting?

[brylie]

@preriasusi we can invoke Swagger UI with several parameters. Which settings do we need to control?

[marla-singer]

@preriasusi Yea, I think it's possible.

[brylie]

For clarification, this task takes us in the direction of being able to use Swagger UI parameters, rather than the iframe, by using an npm module.

We can follow-up with enhancement tasks based on the Swagger UI configuration parameters, etc.