grpc-ecosystem/grpc-gateway

Response forwarder replace docs are unclear

Open

#1087 opened on Nov 25, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
documentationgood first issuehelp wanted

Description

The doc of replace-a-response-forwarder-per-method is not very clear.

We cannot directly access the forward_MyService_Checkout_0 variable outside the generated gw file. If we modify the gw file directly, it will break the automatic generation mechanism.

So what's the recommended way to overwrite the default forwarder?

Contributor guide

Tech stack
gogrpcrest api
Domain
apidocumentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programminggRPC basicsgrpc gateway usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the existing documentation at the provided link and the generated forwarder code. Check if there is a way to inject custom forwarders via options or plugin. Look at related issues or PRs for how others have done it. The maintainer should provide a clear example of overriding the default forwarder without modifying generated files.