angular-swagger-ui icon indicating copy to clipboard operation
angular-swagger-ui copied to clipboard

Question: Benefits & Comparisons

Open mikefidel opened this issue 6 years ago • 2 comments

What are the benefits of running angular-swagger-ui versus just redirecting the user to a web page containing Swagger-UI configured with the desired openapi v3 JSON specification file?

I ask because we have a Swagger-UI instance running in an AWS S3 bucket already. There are thoughts about integrating it into an organization's AngularJS front end. Its believed that sandwiching the AngularJS front-end header and trailer will have a better appearance. Seeking examples on how to do this, ... well, I found this project. It looks well suited to our needs (i.e. supports openapi v3 and basic auth).

I am just looking for confirmation that this project has the right "fit", and what you think its merits are when compared to doing an html redirect to the S3 bucket.

Thanks for your input.

mikefidel avatar Apr 12 '18 23:04 mikefidel

Hi! Sorry for delayed response... Not easy to answer this question :) ! It depends on what is the main goal of your app, and lots of other things

The benefits of using this component are:

  • supports swagger 1.2, swagger 2.0 and openapi 3.0 specs
  • allows easy integration in an app
  • allows full UI customization (css, html)
  • allows behavior customization by using modules or by creating your own ones
  • allows to scroll to model when clicked
  • allows i18n
  • allows enabling/disabling swagger validation
  • provides link to download spec
  • allows loading spec from web or from JS
  • allows defining permalinks to operations and/or models

We had the same questioning on a big project of my compny and we choosed the fully integrated solution. I came up creating this component as no other solution was complete enough in AngularJS.

Hope this helps! Regards

mathieuales avatar Apr 24 '18 13:04 mathieuales

Exactly the depth and detail of information I was looking for. Thanks@mathieuales.

mikefidel avatar Apr 24 '18 18:04 mikefidel