Google gRPC网关：覆盖响应字段？

Question

我目前正在创建一个gRPC服务，该服务使用gRPC网关/HTTP反向代理也提供HTTP支持。我想遵循谷歌API设计的常见惯例。

我在Google API设计指南中找到的示例使用了Google。protobuf。清空删除方法/RPC响应的消息。这很好，但是当我生成一个时。大摇大摆来自的json文件。proto文件使用来自grpc gateway的protoc gen swagger，这是对google的描述。protobuf。空消息作为响应对象的描述被拉入。这与我的API的用户无关，而且可能会让他们感到困惑，因为使用HTTP网关的人没有使用protobufs。

...
"paths": {
  "/v1/{name}": {
    "delete": {
      "summary": "Deletes a book.",
      "operationId": "DeleteBook",
      "responses": {
        "200": {
          "description": "",
          "schema": {
            "$ref": "#/definitions/protobufEmpty"
          }
        }
      },
      ...
    }
  }
},
"definitions": {
  "protobufEmpty": {
    "type": "object",
    "description": "service Foo {\n      rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n    }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
    "title": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:"
  }
}

我想说，这是一个应该由protoc gen swagger插件解决的问题，只是它确实在做它应该做的事情。是否有HTTP注释以某种方式处理或覆盖响应中的字段？如果没有，人们如何处理？




Answer 1

您可以编写一个脚本，在OpenAPI规范由protoc生成后，从中删除不需要的元素。类似于您的。大摇大摆spec.json应该可以工作。