Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render swagger-ui on root endpoint in rest api #1060

Closed
mpetrunic opened this issue Jun 26, 2020 · 7 comments
Closed

Render swagger-ui on root endpoint in rest api #1060

mpetrunic opened this issue Jun 26, 2020 · 7 comments
Assignees

Comments

@mpetrunic
Copy link
Member

It would be nice instead of 404 to render swagger-ui on http://localhost: to load swagger-ui with our server as primary server url.

Until we release spec, we should probably bundle spec into single file and ship it along.
There is some fastify plugin for that probably

@dapplion
Copy link
Contributor

Do you want to bundle up with the beacon chain code the swagger UI, or add it to our CI pipeline publicly like https://api.prylabs.network/ ?

@mpetrunic
Copy link
Member Author

I think it would be useful to bundle it. cc @wemeetagain

@wemeetagain
Copy link
Member

My preference is to not bundle it, or somehow only optionally bundle it for debugging.
This is likewise to not bundling graphiql during production, but using it during development/debugging scenarios.

@dapplion
Copy link
Contributor

dapplion commented Aug 9, 2020

Other clients don't bundle it up. Should this still be pursued? If we follow https://github.com/ethereum/eth2.0-APIs strictly is it necessary to maintain our own swagger UI?

@dapplion dapplion added the Api label Aug 9, 2020
@mpetrunic
Copy link
Member Author

As I compromise, we could add redirect from lodestar api base url to https://github.com/ethereum/eth2.0-APIs .

It would be REALLY nice if we could pass server url somehow. That said, we are missing /eth prefix on all routes
for https://github.com/ethereum/eth2.0-APIs to be effective

@wemeetagain
Copy link
Member

Would like this feature behind a CLI flag.

@wemeetagain wemeetagain reopened this Sep 18, 2023
@wemeetagain wemeetagain self-assigned this Sep 18, 2023
@wemeetagain
Copy link
Member

Resolved with #5970

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants