grpc-ecosystem/grpc-gateway

Hosting the grpc-gateway with an OpenAPI ui?

Open

#2782 opened on Jul 3, 2022

View on GitHub
 (1 comment) (3 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
documentationhelp wanted

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?

Contributor guide

Tech stack
gogrpcrest api
Domain
documentationbackendapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Gogrpc gateway basicsOpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the grpc gateway repository's existing documentation on OpenAPI integration (e.g., docs/ directory) and examples/ folder. Look for any existing swagger ui examples or references. The issue requests adding a clear example of hosting swagger ui alongside the gateway handler, including dependencies and MUX binding. Consider linking to a PR or comment if found.