grpc-ecosystem/grpc-gateway

Suggestion to document gateway transcoding support for other languages.

Open

#834 建立於 2018年12月20日

在 GitHub 查看
 (12 留言) (0 反應) (1 負責人)Go (16,971 star) (2,250 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.