grpc-ecosystem/grpc-gateway

Add example repo to README

Open

#3,208 创建于 2023年2月24日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Go (16,971 star) (2,250 fork)batch import
documentationgood first issuehelp wanted

描述

Hi!

Thanks for all the work put into this project. It's really great.

I would like offer up a link to an example repo I've created. I was thinking that maybe this could be included in the README under the "examples" section.

It took me a while to figure out a few critical details for my use-case, so I thought that it may help others to have a complete example. I believe my project is a decent example (granted it's new and probably could be refined) of the following cases:

  • grpc-gateway handler within another (more standard) router, such as Chi
  • custom base path for all grpc routing with the openapi configuration to support
  • embedded Swagger UI without additional tooling

The demo project also details a few different patterns for defining and interacting with RPCs.

贡献者指南

技术栈
gogrpcrest api
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
95
研究方向
Add a link to the provided example repository (https://github.com/cosmotek/grpc template) in the README under the 'Examples' section. The example demonstrates grpc gateway usage with Chi router, custom base path, and embedded Swagger UI. Follow the existing formatting and style of the README.
Add example repo to README · grpc-ecosystem/grpc-gateway#3208 | Good First Issue