quarkusio / quarkus

Quarkus: Supersonic Subatomic Java.
https://quarkus.io
Apache License 2.0
13.56k stars 2.62k forks source link

Redoc support for OpenAPI #13643

Open Xendar opened 3 years ago

Xendar commented 3 years ago

Describe the extension (Describe the extension clearly and concisely.)

Similarly to the swagger-ui extension, it would be good to have a redoc extension to display the provided OpenAPI spec (instead of, or in complement of swagger one)

Configuration suggestion

Options provided by redoc

Additional context

Not sure this is directly under Quarkus as it would more be part of Smallrye, but I'm trying my luck 😅

ghost commented 3 years ago

/cc @EricWittmann, @MikeEdgar, @phillip-kruger

ambition-consulting commented 3 years ago

Great bang for the buck, easy choice.

Xendar commented 3 years ago

Great bang for the buck, easy choice.

?

ambition-consulting commented 3 years ago

You add a static html and replace sagger UI with it via config option. Maybe have the tag configurable? Costs maybe 100 LOC including documentation and tests.

And in return you get a vastly improved, stunningly beautiful rest documentation.

Vincent Leon notifications@github.com schrieb am So., 28. Feb. 2021, 10:41:

Great bang for the buck, easy choice.

?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/quarkusio/quarkus/issues/13643#issuecomment-787424351, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAF3XSWKZ5F5ONBF2DEIX3TBIFWBANCNFSM4ULAR42A .

Xendar commented 3 years ago

You add a static html and replace sagger UI with it via config option. Maybe have the tag configurable? Costs maybe 100 LOC including documentation and tests.

And in return you get a vastly improved, stunningly beautiful rest documentation.

Vincent Leon notifications@github.com schrieb am So., 28. Feb. 2021, 10:41:

Great bang for the buck, easy choice.

?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/quarkusio/quarkus/issues/13643#issuecomment-787424351, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAF3XSWKZ5F5ONBF2DEIX3TBIFWBANCNFSM4ULAR42A .

Seems easy said like that! If I find some time I may try to have a look a bit at how this works 🙂

EricWittmann commented 3 years ago

If it helps, we use ReDoc in Apicurio Registry for this purpose. The HTML is here:

https://github.com/Apicurio/apicurio-registry/blob/feat/artifact-groups/app/src/main/resources-unfiltered/META-INF/resources/apidocs/apidocs.html

In our case we support several different APIs, which is why SPEC_URL is not static. But it's that simple and it looks really good.

Screen shots:

image

image

Chanizo commented 2 years ago

Hi ! We are interested by this feature, last message was one year ago, is there some news on this ? :)

phillip-kruger commented 2 years ago

No news on this. Could be an interesting case for Quarkiverse if you are interested to contribute