grpc-ecosystem/grpc-gateway

Hosting the grpc-gateway with an OpenAPI ui?

Open

#2.782 geöffnet am 3. Juli 2022

Auf GitHub ansehen
 (1 Kommentar) (3 Reaktionen) (0 zugewiesene Personen)Go (2.250 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (16.971 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 4h) (141 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuchen Sie die vorhandene Dokumentation zur OpenAPI Integration im grpc gateway Repository (z. B. docs/ Verzeichnis) und den examples/ Ordner. Suchen Sie nach vorhandenen swagger ui Beispielen oder Referenzen. Das Issue fordert ein klares Beispiel für das Hosten von swagger ui zusammen mit dem Gateway Handler, einschließlich Abhängigkeiten und MUX Bindung. Erwägen Sie, auf einen PR oder Kommentar zu verlinken, falls gefunden.
Tech Stack
go
Domain
apidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Recherche nötig
Voraussetzungen
GogRPCbufswagger ui
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60