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.

Sign up for GitHub

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

Jump to bottom

Central Gateway Swagger-UI showing all service's openapi docs #19

Open
ChromaChroma opened this issue Jul 4, 2022 · 0 comments · May be fixed by #83
Open

Central Gateway Swagger-UI showing all service's openapi docs #19

ChromaChroma opened this issue Jul 4, 2022 · 0 comments · May be fixed by #83
Assignees
@ChromaChroma
Labels
enhancement Refactor or redesign of existing features / code
Milestone
v1.0 - Microservi...

Comments

@ChromaChroma
Copy link
Collaborator

ChromaChroma commented Jul 4, 2022 •
edited
Loading

Swagger-UI

Search if posible to do during runtime, or if a combined Swagger-docs file build is needed during build time

Create Swagger UI in Gateway that can show endpoint info of all underlaying services.

https://github.com/GnanaJeyam/microservice-patterns/tree/master/centralized-swagger-docs
^^^^^^^^^^^Voorbeeld (met Eurka servicediscovery ) van combined UI^^^^^^^^^^

Possibilities

  • Make one page with all service endpoints
  • Make page with Docker (dropdown) for each :
    controller
    Or
    (self-specified) set of endpoints (OpenAPI3 @group annotation or something?)

!!
Check if endpoints show the inside service URI or gateway URI.
This could create misunderstanding of endpoints otherwise.
If so check if the URI's shown can be configured (automaticly)
!!

References

https://stackoverflow.com/questions/63675544/springdoc-with-multiple-api-docs
https://springdoc.org/faq.html#how-can-i-agreagte-external-endpoints-exposing-openapi-3-spec-inside-one-single-application
https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
@ChromaChroma ChromaChroma added the enhancement Refactor or redesign of existing features / code label Jul 4, 2022
@ChromaChroma ChromaChroma added this to the v1.0 milestone Jul 4, 2022
@ChromaChroma ChromaChroma moved this from Backlog to Todo in Bartap project management Jul 8, 2022
@ChromaChroma ChromaChroma moved this from Todo to In Progress in Bartap project management Jul 8, 2022
@ChromaChroma ChromaChroma self-assigned this Jul 8, 2022
@ChromaChroma ChromaChroma moved this from In Progress to Todo in Bartap project management Jul 9, 2022
@ChromaChroma ChromaChroma changed the title Swagger-UI on Gateway Showing multi server endpoints Central Gateway Swagger-UI showing all service's openapi docs Jul 9, 2022
@ChromaChroma ChromaChroma moved this from Todo to Backlog in Bartap project management Jul 18, 2022
@ChromaChroma ChromaChroma moved this from Backlog to In Progress in Bartap project management Jul 28, 2022
@ChromaChroma ChromaChroma moved this from In Progress to Todo in Bartap project management Jul 28, 2022
@ChromaChroma ChromaChroma moved this from Todo to Backlog in Bartap project management Jul 28, 2022
@ChromaChroma ChromaChroma moved this from Backlog to In Review in Bartap project management Jul 31, 2022
@ChromaChroma ChromaChroma linked a pull request Jul 31, 2022 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ChromaChroma ChromaChroma

Labels
enhancement Refactor or redesign of existing features / code
Projects
Bartap project management
Archived in project
Milestone
v1.0 - Microservice rebuild
Development

Successfully merging a pull request may close this issue.

Feature/19 gateway centralized swagger UI tungstun-ict/bartap-backend
1 participant
@ChromaChroma