Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix customizing your gateway documentation CustomMatcher example #1142

Merged
merged 2 commits into from
Feb 29, 2020
Merged

Fix customizing your gateway documentation CustomMatcher example #1142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8962bb8
Fix customizing your gateway documentation CustomMatcher example
wiliamsouza Feb 28, 2020
94f8d0f
Add more documentation about mapping from HTTP request headers to gRP…
wiliamsouza Feb 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions docs/_docs/customizingyourgateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ You might not like [the default mapping rule](http://godoc.org/github.com/grpc-e
```go
func CustomMatcher(key string) (string, bool) {
switch key {
case "x-custom-header1":
case "X-Custom-Header1":
return key, true
case "x-custom-header2":
case "X-Custom-Header2":
return "custom-header2", true
default:
return key, false
Expand All @@ -98,8 +98,39 @@ You might not like [the default mapping rule](http://godoc.org/github.com/grpc-e
...

mux := runtime.NewServeMux(runtime.WithIncomingHeaderMatcher(CustomMatcher))

```
To keep the [the default mapping rule](http://godoc.org/github.com/grpc-ecosystem/grpc-gateway/runtime#DefaultHeaderMatcher) alongside with your own rules write:

```go
func CustomMatcher(key string) (string, bool) {
switch key {
case "X-User-Id":
return key, true
default:
return runtime.DefaultHeaderMatcher(key)
}
}
```
It will work with both:

```bash
curl --header "x-user-id: 100d9f38-2777-4ee2-ac3b-b3a108f81a30" ...
```
and:
```bash
curl --header "X-USER-ID: 100d9f38-2777-4ee2-ac3b-b3a108f81a30" ...
```
To access this header on gRPC server side use:
```go
...
userID := ""
if md, ok := metadata.FromIncomingContext(ctx); ok {
if uID, ok := md["x-user-id"]; ok {
userID = strings.Join(uID, ",")
}
}
...
```

## Mapping from gRPC server metadata to HTTP response headers
ditto. Use [`WithOutgoingHeaderMatcher`](http://godoc.org/github.com/grpc-ecosystem/grpc-gateway/runtime#WithOutgoingHeaderMatcher).
Expand Down