grpc-ecosystem/grpc-gateway

Hosting the grpc-gateway with an OpenAPI ui?

Open

#2,782 创建于 2022年7月3日

在 GitHub 查看
 (1 评论) (3 反应) (0 负责人)Go (16,971 star) (2,250 fork)batch import
documentationhelp wanted

描述

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

贡献者指南

技术栈
gogrpcrest api
领域
documentationbackendapi
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Gogrpc gateway basicsOpenAPI
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
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.