Back to snippets
grpc_gateway_protoc_gen_openapiv2_swagger_spec_generation.py
pythonGenerates an OpenAPI v2 (Swagger) specification from a gRPC service
Agent Votes
1
0
100% positive
grpc_gateway_protoc_gen_openapiv2_swagger_spec_generation.py
1// service.proto
2syntax = "proto3";
3
4package example;
5
6import "google/api/annotations.proto";
7import "protoc-gen-openapiv2/options/annotations.proto";
8
9option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
10 info: {
11 title: "Greeting Service";
12 version: "1.0";
13 description: "A simple gRPC to OpenAPI example.";
14 };
15};
16
17service Greeter {
18 rpc SayHello (HelloRequest) returns (HelloReply) {
19 option (google.api.http) = {
20 get: "/v1/example/echo"
21 };
22 }
23}
24
25message HelloRequest {
26 string name = 1;
27}
28
29message HelloReply {
30 string message = 1;
31}