volbrene / redoc Goto Github PK

Thanks for useful tool. It would be nice to be able to set Redoc options from environment variables for example.

I see it like this:

docker run -d -e REDOC_OPTIONS="{hideLoading: true, nativeScrollbars: false}" ... volbrene/redoc

How do we allow subpath?

The domain is https://api.example.com and the subpath is https://api.example.com/redoc

Hi, found out yesterday that Chrome 80 release broke the left menus in Redoc, they have fixed the issue but I had to update your package.json locally to use

"redoc": "^2.0.0-rc.23",

and then npm install to rebuild the package-lock.json and npm run build to get a new build.

I'm working fine on my side but wanted to let you know.
BTW everyone loves the viewer so we thank you for open sourcing it.
Thanks
Gregg

Hi..! Thanks a lot for creating open-source amazing project. i have tried it's awesome however i am trying to customize it as per need and facing some issue if you help with it.

i have created docker images like

FROM volbrene/redoc
COPY . /usr/share/nginx/html/

Adding my local yaml files inside docker image and running docker image like

docker run -p 80:80 -e URLS="[{url: '/instagram.yaml', name: 'insta-service'}, {url: '/petstore.yaml', name: 'Petshop'}, {url: '/test-service/swagger.yaml', name: 'account-service'}]" redoc-test-1

i have tried the same swagger-ui it's working well by adding local files at path /usr/share/nginx/html/ i have tried here but it giving error.

i have used same YAML used in

docker run -d -p 80:80 -e URLS="[{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petshop'},{url: 'https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml', name: 'Instagram'}]" volbrene/redoc

Can you help here i want to add files in docker images and expose UI then.

Thanks...!

A thought or suggestion that might help others then me..

I have a rather big project using a lot of ingress routing to match different paths to different microservices. I would really love to serve this redoc at /docs, the problem is that react is still fetching the resources from the root, so it can't find them. This can be solved by (not sure all steps are included):

1. Update your BrowserRouter by adding a basename. Example: <BrowserRouter history={history} basename="/webapp">.
2. Specify a homepage on your package.json. Example: "homepage": "/webapp".
3. Referencing a static file by it's relative path, you should add the subdirectory to that reference. Example: src="/static/logo/logo.png" becomes src="/webapp/static/logo/logo.png"

I'm not sure if it would be possible to actually do this by configuration - haven't tried but it would be really nice. :-)

Hello! I am considering using this project, as it nicely combines swagger apis into one portal, but it would integrate better with our existing traffic routing if I was able to specify a prefix URL to the application (i.e. serve the homepage at /foobar and serve apis at /foobar/petshop and /foobar/instagram).

This is actually quite easy with the basename prop to the BrowserRouter component you are already using. I think it'd be convenient if one could specify this as an environment variable to your Dockerfile. Opening a PR for this that I'd love review on when you're able to take a look.

Hi I work for a company that would like to use this software, we are happy with its management of multiple files which has been a problem we have been looking to solve for a while. Would you consider adding a license file so that we could understand what ability we have to use, modify, etc. I have taken the code and changed images files for our branding and would like to remove your name from the lower right corner, but would maintain copyright info in your code, but we have not deployed this software due to lack of licensing.
I have used this link to help me review licenses in the past https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#choosing-the-right-license . personally I try to use mit or apache 2.0 but that is your call. Without a license file, according to the link no one has any rights to use this code.

Thanks
Gregg

Hi, thanks for this image
But is it mandatory to mount a volume for the local files ?

Can I not copy over the files to the docker container and pass them as spec files to redoc ?

P.S - I have read through this issue - #3