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

document optional swagger plugin for unannotated grpc_api_configuration #1588

Merged
merged 2 commits into from
Aug 12, 2020
Merged

document optional swagger plugin for unannotated grpc_api_configuration #1588

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39a3177
add the optional swagger plugin
piengeng Aug 12, 2020
154f1c7
Update docs/_docs/grpcapiconfiguration.md
piengeng Aug 12, 2020
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
7 changes: 7 additions & 0 deletions docs/_docs/grpcapiconfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,11 @@ The following is equivalent to the basic [usage example](usage.html) but without

This will generate a reverse proxy `gen/go/your/service/v1/your_service.pb.gw.go` that is identical to the one produced for the annotated proto.

6. Generate the optional your_service.swagger.json

```sh
protoc -I. --swagger_out=grpc_api_configuration=path/to/your_service.yaml:./gen/go \
your/service/v1/your_service.proto
```

All other steps work as before. If you want you can remove the googleapis include path in step 3 and 4 as the unannotated proto no longer requires them.