Swagger-editor vs Swagger-ui: Will Swagger-editor replace Swagger-ui?

[Joseph Lust]

First of all, great framework! Documenting a REST API has never been easier.

I've spent the last month fully documenting my company's API using Swagger, but one thing still doesn't comport. The swagger-editor appears to have more features than swagger-ui. This is confusing because after getting everything working with the swagger-editor, I try to deploy it on swagger-ui, but it won't work well because of the missing features. So, I'm left using the swagger-editor to read the documentation.

swagger-ui missing features:

• swagger-editor parses my "securityDefinitions" block and creates and handles the Basic Authentication for the API on the methods that require it, swagger-ui does not
• swagger-editor parses API method/call "security" directives, swagger-ui does not match named clientAuthorizations to the proper API test forms 
• swagger-editor displays all Models in an interactive list at the page footer, swagger-ui does not
• (cosmetic) but swagger-editor looks cleaner and more modern than swagger-ui

Confusion:

Why don't these projects move together? Shouldn't the 2.0 YAML editor on swagger-editor work the same on swagger-ui since they both support Swagger Spec 2.0? Why not stop the swagger-ui project and allow the running of swagger-editor in a ready only mode as it already has a better presentation mode?

Thanks for answering my naive question.

Sincerely,

-Joe

[Ron Ratovsky]

Hi Joe,

Thanks for the elaborate email and thoughts.

swagger-editor and swagger-ui are now indeed two separate projects and were build independently of each other.

swagger-ui is the older project and was released as part of the initial Swagger ecosystem. swagger-editor was released as part of the work on Swagger 2.0.

Not diving into details, swagger-ui has a few features that are not available in the editor (in functionality and customization).

There are many reasons why people would prefer using swagger-ui over swagger-editor, at the base of it, is the ability to run swagger-ui as a set of static files and not as a Node application.

For what it's worth, we do have plans of revamping swagger-ui in a way that it would actually replace the viewer side of swagger-editor, allowing people to have the same features and the same look-n-feel in both places.

This would obviously mean that the additional features in swagger-editor's viewer would be included in swagger-ui, but eventually there would be a stand-alone project that would be available.

Whether the revamp would be based on the existing code of swagger-ui, the codebase of swagger-editor or something completely different is yet to be determined.

BR,

Ron

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

[Galen Parker]

Hi Joseph and Ron,

I just wanted to chime in here that as a new to swagger user (this week) but already a huge fan I've hit this exact same stumbling block.

Swagger Editor with better security options and auth support and a prettier design.

Swagger UI even built from source missing the above.

Just to confirm... the rendering component of the Swagger Editor is not available as standalone thing at the moment?

Is there an open github issue or somewhere I could subscribe to follow the progress of this as we are very keen to proceed with swagger as the backbone of our API documentation but want to just navigate this minor hurdle.

Thanks in Advance

Galen

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Ron Ratovsky]

That is correct. The rendering component of the Swagger Editor is currently not available as a standalone component.

I don't recall if there's a specific issue for it, and it probably won't be done in the immediate future.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Joseph R Lust]

@Galen,

For now I'm just using swagger-ui for the presentation. I had to make various custom JS modifications to the page to make it work with the proper security handlers, essentially in-lining them.

Sincerely,
Joseph

You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/wcWATKue8j8/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

[Jonas Lodewegen]

Hello guys,

I'm currently implementing Swagger for the REST API o the company I work for. It's starting to get shape and we're very enthusiastic. However, I was wondering whether the swagger-ui will get the same look and feel as the editor, someday. For instance, a POST request in the editor shows input fields automatically, where swagger-ui displays one big textfield where you have to specify the values of the fiels with JSON. A lot less customer friendly, I'd say.

I'll be happy to here from you guys, if you know anything.

Regards,

Jonas

Op woensdag 15 april 2015 16:51:07 UTC+2 schreef Joseph Lust:

Sincerely,
Joseph

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsubscri...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

--

You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/wcWATKue8j8/unsubscribe.

To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

[Josh Ponelat]

There will be a time, when the UI's must fight each other to the death! For superiority over the swagger-dom (pun!).

However, each has its purpose (and architecture). So that time is not now.

If there are particular features you'd like to see in swagger-ui (or swagger-editor) please feel free to post issues. Or better yet, create Pull-Requests ;)

Jonas

Sincerely,
Joseph

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

--

You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/wcWATKue8j8/unsubscribe.

To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

[Angel Cervera Claudio]

Now, swagger-editor can be used in any http server, because all is static code.
So maybe, the solution is to modify swagger-editor to have a read-only version.

What were your solution?

Sincerely,
Joseph

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsubscri...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

--

You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/wcWATKue8j8/unsubscribe.

To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.