从原始文件创建swagger.json文件的混淆

Question

我已经创建了一个proto文件，其中包含我打算生成的REST Web服务的所有必要消息和rpc函数。使用proc-gen-swagger插件，我设法将该proto文件编译成一个swagger.json文件，一切似乎都很好，除了两件事，我似乎无法解决。

>

swagger.json文件中的所有定义都以我的原始文件包的名称为前缀。有没有办法摆脱这个？

我的消息的所有字段都是“可选的”。它们没有被明确指定为这样，但它们没有被指定为“必需”，根据定义，这使得它们是可选的。Proto3不再支持required/optional/repeating，但即使我使用Proto2并添加这些关键字，它似乎也不会影响招摇过市。json输出。如何在proto文件中指定需要一个字段，以便protoc gen swagger将所需的部分添加到json输出中？

这是一个非常基本的原始文件示例：

webservice.proto

syntax = "proto3";
package mypackage;
import "google/api/annotations.proto";

service MyAPIWebService {
    rpc MyFunc (MyMessage) returns (MyResponse) {
        option (google.api.http) = {
            post: "/message"
            body: "*"
        };
    }
}

message MyMessage {
    string MyString = 1;
    int64 MyInt = 2;
}

message MyResponse {
    string MyString = 1;
}

然后，这被编译成一种炫耀。带有以下命令的json文件：

协议-I.-I“%GOPATH%/src/github.com/grpc生态系统/grpc网关/第三方/googleapis”--swagger\u out=logtostderr=true:。webservice。原型

产生以下输出：webservice.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "webservice.proto",
    "version": "version not set"
  },
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/message": {
      "post": {
        "operationId": "MyFunc",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/mypackageMyResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/mypackageMyMessage"
            }
          }
        ],
        "tags": [
          "MyAPIWebService"
        ]
      }
    }
  },
  "definitions": {
    "mypackageMyMessage": {
      "type": "object",
      "properties": {
        "MyString": {
          "type": "string"
        },
        "MyInt": {
          "type": "string",
          "format": "int64"
        }
      }
    },
    "mypackageMyResponse": {
      "type": "object",
      "properties": {
        "MyString": {
          "type": "string"
        }
      }
    }
  }
}

>

注意proto文件中的MyMessage和MyACK如何转换为json文件中的mypack ageMyMessage和mypack ageMyACK。

例如，如果我希望需要MyMessage： MyString，我必须在“定义”中的“mypack ageMyMessage”部分中添加一个部分，如下所示：

“必需”：[“MyString”]

如果有一种方法可以在proto文件中指定，那么我肯定会更喜欢，这样我就不必每次编译json文件时都手动编辑它。

Answer 1

您的前缀mypackage是中命名空间的一部分。原型文件。它来自以下行：package-mypackage 删除此行并重新生成json

Answer 2

在这里发帖给任何遇到这个问题寻找相同信息的人。

更新这是代码定义如何创建定义的地方。

https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-swagger/genswagger/template.go#L859

这就是您可以根据需要表示字段的方式--在消息定义中添加一个自定义选项：

message MyMessage {
    option (grpc.gateway.protoc_gen_swagger.options.openapiv2_schema) = {
        json_schema: {
            title: "MyMessage"
            description: "Does something neat"
            required: ["MyString"]
        }
    };

    string MyString = 1;
    int64 MyInt = 2;
}