Skip to content

Commit

Permalink
Merge pull request #97 from achew22/documentation
Browse files Browse the repository at this point in the history
Add documentation for using Swagger
  • Loading branch information
yugui committed Jan 28, 2016
2 parents f7797d4 + c904ba8 commit f2a9936
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit f2a9936

Please sign in to comment.