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.