grpc-ecosystem/grpc-gateway

Hosting the grpc-gateway with an OpenAPI ui?

Open

#2 782 ouverte le 3 juil. 2022

Voir sur GitHub
 (1 commentaire) (3 réactions) (0 assignés)Go (2 250 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (16 971 stars)
Métriques de merge PR
 (Merge moyen 1j 4h) (141 PRs mergées en 30 j)

Description

📚 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?

Guide contributeur

Direction de recherche
Examinez la documentation existante sur l'intégration OpenAPI dans le dépôt grpc gateway (par exemple, le répertoire docs/) et le dossier examples/. Recherchez tout exemple ou référence existant à swagger ui. L'issue demande d'ajouter un exemple clair d'hébergement de swagger ui aux côtés du gestionnaire de passerelle, incluant les dépendances et la liaison MUX. Envisagez de créer un lien vers une PR ou un commentaire si trouvé.
Stack technique
go
Domaine
apidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Investigation requise
Prérequis
GogRPCbufswagger ui
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60