From 506f75f7fd3ff47c9c4ce745c181e164bc039246 Mon Sep 17 00:00:00 2001 From: Travis Cline Date: Sun, 27 Nov 2016 16:18:23 -0800 Subject: [PATCH] describe default marshaler in README.md (#266) * add note about default marshaler * note the default marshaler/unmarhsaler --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 718047f3234..f5629b1f341 100644 --- a/README.md +++ b/README.md @@ -204,7 +204,7 @@ To use the same port for custom HTTP handlers (e.g. serving `swagger.json`), gRP * Method parameters in request body * Method parameters in request path * Method parameters in query string -* Mapping streaming APIs to JSON streams +* Mapping streaming APIs to newline-delimited JSON streams * Mapping HTTP headers with `Grpc-Metadata-` prefix to gRPC metadata * Optionally emitting API definition for [Swagger](http://swagger.io). * Setting [gRPC timeouts](http://www.grpc.io/docs/guides/wire.html) through inbound HTTP `Grpc-Timeout` header. @@ -229,6 +229,7 @@ But patch is welcome. * HTTP request host is added as `X-Forwarded-Host` gRPC request header * HTTP `Authorization` header is added as `authorization` gRPC request header * Remaining HTTP header keys are prefixed with `Grpc-Metadata-` and added with their values to gRPC request header +* While configurable, the default {un,}marshaling uses [jsonpb](https://godoc.org/github.com/golang/protobuf/jsonpb) with `OrigName: true`. # Contribution See [CONTRIBUTING.md](http://github.com/grpc-ecosystem/grpc-gateway/blob/master/CONTRIBUTING.md).