You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Point users to the proto definition instead of Service Management API documentation. Latter is generated from former, and is more likely to be out of date.
Rephrase "custom options" to "google.api.http" annotation to be more straight forward.
Copy file name to clipboardExpand all lines: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,9 @@
5
5
grpc-gateway is a plugin of [protoc](http://github.com/google/protobuf).
6
6
It reads [gRPC](http://github.com/grpc/grpc-common) service definition,
7
7
and generates a reverse-proxy server which translates a RESTful JSON API into gRPC.
8
-
This server is generated according to [custom options](https://cloud.google.com/service-management/reference/rpc/google.api#http) in your gRPC definition.
It helps you to provide your APIs in both gRPC and RESTful style at the same time.
11
13
@@ -20,7 +22,7 @@ However, you might still want to provide a traditional RESTful API as well. Reas
20
22
This project aims to provide that HTTP+JSON interface to your gRPC service. A small amount of configuration in your service to attach HTTP semantics is all that's needed to generate a reverse-proxy with this library.
21
23
22
24
## Installation
23
-
First you need to install ProtocolBuffers 3.0.0-beta-3 or later.
25
+
First you need to install ProtocolBuffers 3.0.0 or later.
24
26
25
27
```sh
26
28
mkdir tmp
@@ -59,7 +61,7 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`.
2. Add a [custom option](https://cloud.google.com/service-management/reference/rpc/google.api#http) to the .proto file
64
+
2. Add a [`google.api.http`](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto#L46) to your .proto file
63
65
64
66
your_service.proto:
65
67
```diff
@@ -83,7 +85,7 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`.
83
85
}
84
86
```
85
87
86
-
If you do not want to modify the proto file for use with grpc-gateway you can alternatively use an external [gRPC API Configuration](https://cloud.google.com/endpoints/docs/grpc/grpc-service-config) file. [Check our documentation](https://grpc-ecosystem.github.io/grpc-gateway/docs/grpcapiconfiguration.html) for more information.
88
+
If you do not want to modify the proto file for use with grpc-gateway you can alternatively use an external [gRPC Service Configuration](https://cloud.google.com/endpoints/docs/grpc/grpc-service-config) file. [Check our documentation](https://grpc-ecosystem.github.io/grpc-gateway/docs/grpcapiconfiguration.html) for more information.
0 commit comments