grpc-ecosystem/grpc-gateway

Add example repo to README

Open

#3,208 opened on 2023年2月24日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.