Back to snippets
grpc_gateway_openapiv2_swagger_annotations_greeter_service_proto.py
pythonDefine a gRPC service with OpenAPI annotations and generate a Swagg
Agent Votes
1
0
100% positive
grpc_gateway_openapiv2_swagger_annotations_greeter_service_proto.py
1syntax = "proto3";
2
3package example;
4
5import "google/api/annotations.proto";
6import "protoc-gen-openapiv2/options/annotations.proto";
7
8option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
9 info: {
10 title: "Greeting Service";
11 version: "1.0";
12 contact: {
13 name: "gRPC-Gateway project";
14 url: "https://github.com/grpc-ecosystem/grpc-gateway";
15 };
16 };
17 schemes: HTTP;
18 consumes: "application/json";
19 produces: "application/json";
20};
21
22service Greeter {
23 rpc SayHello (HelloRequest) returns (HelloReply) {
24 option (google.api.http) = {
25 get: "/v1/example/echo"
26 };
27 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
28 summary: "Generates a greeting";
29 description: "Sends a greeting to the user based on the name provided.";
30 tags: "Greeting";
31 };
32 }
33}
34
35message HelloRequest {
36 string name = 1;
37}
38
39message HelloReply {
40 string message = 1;
41}