grpc-ecosystem/grpc-gateway

Suggestion to document gateway transcoding support for other languages.

Open

#834 opened on Dec 20, 2018

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

Description

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.

Contributor guide

Tech stack
gogrpc
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
basic understanding of protobuffamiliarity with gRPC HTTP annotations
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
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.