grpc-ecosystem/grpc-gateway

Suggestion to document gateway transcoding support for other languages.

Open

#834 opened on 2018年12月20日

GitHub で見る
 (12 comments) (0 reactions) (1 assignee)Go (16,971 stars) (2,250 forks)batch import
documentationhelp wanted

説明

If using the http annotations it's rather complicated to get code to compile across languages. Many resort to copying the common annotations in the project in order for protoc to generate the compile time dependencies (e.g. https://github.com/xolstice/protobuf-maven-plugin/issues/14) Instead you need https://github.com/googleapis/api-common-protos dependencies in each language to have them at compile time.

Also the protos need to be available to protoc when resolving the includes.

コントリビューターガイド

技術スタック
gogrpc
領域
documentationapi
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
needs maintainer response
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
needs investigation
前提条件
basic understanding of protobuffamiliarity with gRPC HTTP annotations
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
25
調査方針
Investigate the common protos in api common protos repository and understand how to include them in different languages. Review the linked issue (xolstice/protobuf maven plugin#14) to see typical workarounds. Identify the exact steps and dependencies needed per language (Go, Java, Python, etc.) and propose documentation that explains how to set up compilation with the required protos. Consult existing documentation in the grpc gateway repo for similar patterns.