Migrate ReDoc to React - Githubissues

RomanHotsiy commented 7 years ago

Hey, ReDoc community!

To support OpenAPI 3.0 I am working on a major refactor of the codebase. As part of this refactor I am considering rewriting ReDoc view layer completely to React.

Why? I've been working with React on a few side project for the last 5-6 month and I really loved working with it comparing to Angular:

much much simpler, no magic
more performant (especially since React 16 release aka Fiber)
the community is healthier - much more stable ready-to use modules (there are lots in Angular too, but usually they are part of some huge UI-packs)
smaller bundle size
simpler to build-in live updates
server-side rendering actually working
I love styled-components

Also, I often hear in the issues or PRs that "I don't know Angular but I will try". Probably React can lower the barrier for new contributors.

I will try to achieve fully backward compatibility with the Angular version.

Now I want to hear the voice of community! What do you think? Do you find this idea is good or bad! Any concerns! Or just vote 👍 or 👎

Thanks in advance!

cc contributors (sorry for bothering): @bfirsh @brendo @adamaltman @cesarlevel @IvanGoncharov @amanganiello @kedashoe @alairock @Joe-noh @gierschv @jsmartfo @jaingaurav @agallou @jacobbaskin @MikeRalphson @bennyn @adamd @LeFnord @wilsonge @philsturgeon @khorolets @pgolm @jfeltesse-mdsol @Alfaspider @oblakeerickson @Jean-Daniel @KtorZ @jimmyjames @bioball

RomanHotsiy commented 6 years ago

I've just quickly hacked up an example of using ReDoc as a React Component with create-react-app. Here it is: https://github.com/APIs-guru/create-react-app-redoc

And here are only changes required to install and use ReDoc: https://github.com/APIs-guru/create-react-app-redoc/commit/da80371ddc7e2b078022a3cb91403be171e40037

runes83 commented 6 years ago

Hello @RomanGotsiy,

Any update on the move to react?

wopian commented 6 years ago

@runes83 its being actively worked on over in https://github.com/Rebilly/ReDoc/pull/357 👍

RomanHotsiy commented 6 years ago

I think this can be closed already 😃

pvs1 commented 5 years ago

I have a bulky swagger.json and the page takes forever to load with Redoc standalone . Is there a way to get around it? Appreciate any input in advance. Thanks

adamaltman commented 5 years ago

@pvs1 we're sorry... we don't have a free open source version that will do that. We do have a paid version which has further performance enhancements. If you are interested, you can try it out for a free trial. You can reach us via the email at the bottom of https://redoc.ly

Redocly / redoc

Migrate ReDoc to React #327