From c904ba8e442b4f5d233f29fa82876b451eefee48 Mon Sep 17 00:00:00 2001 From: Andrew Z Allen Date: Wed, 27 Jan 2016 22:42:04 -0700 Subject: [PATCH] Add documentation for using Swagger --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f389232f91f..5b5fdfd3f94 100644 --- a/README.md +++ b/README.md @@ -168,6 +168,16 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`. } ``` +7. (Optional) Generate swagger definitions + + ```sh + protoc -I/usr/local/include -I. \ + -I$GOPATH/src \ + -I$GOPATH/src/github.com/gengo/grpc-gateway/third_party/googleapis \ + --grpc-swagger_out=logtostderr=true:. \ + path/to/your_service.proto + ``` + ## More Examples More examples are available under `examples` directory. * `examplepb/echo_service.proto`, `examplepb/a_bit_of_everything.proto`: service definition @@ -184,12 +194,12 @@ More examples are available under `examples` directory. * Method parameters in query string * Mapping streaming APIs to JSON streams * Mapping HTTP headers with `Grpc-Metadata-` prefix to gRPC metadata +* Optionally emitting API definition for [Swagger](http://swagger.io). ### Want to support But not yet. * bytes and enum fields in path parameter. #5 * Optionally generating the entrypoint. #8 -* Optionally emitting API definition for [Swagger](http://swagger.io). #9 ### No plan to support But patch is welcome.