如何从swagger grpc生成的代码中排除字段

Question

我正在尝试使用https://github.com/pseudomuto/protoc-gen-doc，我无法找到在消息中排除grpc服务/字段的一些API的方法。

在swagger中找到了相关的样式，但似乎找不到将其添加到Pro buf文件中的方法http://watson-developer-cloud.github.io/api-guidelines/swagger-coding-style.html#excluding-operations-from-the-sdks

service MyService {
    rpc ExternalApi (ExternalApiRequest) returns (ExternalApiResponse) {
        option (google.api.http) = {
            post: "/my/externalApi"
        };
    }
    rpc InternalApi (InternalApiRequest) returns (InternalApiResponse) {
        option (google.api.http) = {
            post: "/my/internalApi"
        };
    }

message ExternalApiResponse { 
string prefix = 1;
string id = 2;  // field to exclude
}

// message to exclude
message Header { }

是否有办法从协议缓冲区文件中排除操作/字段？

Answer 1

您可以添加

string id = 2 [(grpc.gateway.protoc_gen_swagger.options.openapiv2_field).read_only = true];