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

Jump to bottom

Add documentation for using Swagger #97

Merged
merged 1 commit into from
Jan 28, 2016
Merged

Add documentation for using Swagger #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
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