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

Add OpenAPI docs and UI for our APIs #45

Open
zweizeichen opened this issue Feb 9, 2018 · 0 comments
Open

Add OpenAPI docs and UI for our APIs #45

zweizeichen opened this issue Feb 9, 2018 · 0 comments

Comments

@zweizeichen
Copy link
Member

Now that we have switched to gRPC for our cluster's internal communication we can generate OpenAPI docs by using grpc-gateway on which jumpgate is based. The individual service's Protobuf annotations are there, we just need to combine the individual generated Swagger docs using something like swagger-combine and package them up for deployment with swagger-ui. We may even be able to use parts of esi-swagger-ui so our docs would look like ESI's documentation.

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

No branches or pull requests

1 participant