grpc-ecosystem/grpc-gateway

Hosting the grpc-gateway with an OpenAPI ui?

Aperta

#2782 aperta il 3 lug 2022

Vedi su GitHubGuida contributor
 (1 commento) (3 reazioni) (0 assegnatari)Go (2250 fork)batch import
documentationhelp wanted

Metriche repository

Star
 (16.971 stelle)
Metriche merge PR
 (Merge medio 8g 23h) (147 PR mergiate in 30 g)

Descrizione

📚 Documentation

I have generates the OpenAPI file with buf but for me it is not clear how can I add the swagger-ui to my gateway service. I have bind the the gateway-handler and this works. I would like to add a second path localhost:8081/doc a swagger-ui, so it is possible to show / test the gateway via REST request. Could be added an example to the documentation for adding the swagger-ui? I have got some open questions:

  • Did I need additional dependencies?
  • Can I build with buf the stub for the HTTP server?
  • Did I need some middelware component?
  • How can bind the mux of the grpc-gateway with the swagger-ui together?

Guida contributor

Direzione di ricerca
Indaga la documentazione esistente sull'integrazione OpenAPI nel repository grpc gateway (ad es., directory docs/) e la cartella examples/. Cerca eventuali esempi o riferimenti esistenti a swagger ui. La richiesta dell'issue è di aggiungere un esempio chiaro di hosting di swagger ui insieme al gestore del gateway, incluse le dipendenze e il binding MUX. Considera di collegare a una PR o a un commento se trovato.
Tech stack
go
Dominio
apidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Richiede indagine
Prerequisiti
GogRPCbufswagger ui
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60