Skip to content

Commit

Permalink
README: replace Swagger by OpenAPI (grpc-ecosystem#1749)
Browse files Browse the repository at this point in the history
Also remove paragraph duplicated during the merge v2->master
  • Loading branch information
olivierlemasle authored Oct 14, 2020
1 parent 03195a1 commit 58213a4
Showing 1 changed file with 1 addition and 13 deletions.
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ Make sure that your `$GOBIN` is in your `$PATH`.
protoc -I . --openapiv2_out ./gen/openapiv2 --openapiv2_opt logtostderr=true your/service/v1/your_service.proto
```
Note that this plugin also supports generating swagger definitions for unannotated methods; use the `generate_unbound_methods` option to enable this.
Note that this plugin also supports generating OpenAPI definitions for unannotated methods; use the `generate_unbound_methods` option to enable this.
## Video intro
Expand Down Expand Up @@ -312,18 +312,6 @@ through protoc using one of 2 patterns:
--openapiv2_opt logtostderr=true --openapiv2_opt repeated_path_param_separator=ssv
```
* using additional `--<tool_suffix>_opt` parameters: `--<tool_suffix>_opt=<flag>[,<flag>]*`
```sh
--grpc-gateway_opt logtostderr=true,repeated_path_param_separator=ssv
# or separately
--grpc-gateway_opt logtostderr=true --grpc-gateway_opt repeated_path_param_separator=ssv
--swagger_opt logtostderr=true,repeated_path_param_separator=ssv
# or separately
--swagger_opt logtostderr=true --swagger_opt repeated_path_param_separator=ssv
```
`protoc-gen-grpc-gateway` supports custom mapping from Protobuf `import` to
Golang import paths. They are compatible with
[the parameters with the same names in `protoc-gen-go`](https://github.com/golang/protobuf#parameters).
Expand Down

0 comments on commit 58213a4

Please sign in to comment.