gRPC与Swagger所用注释的不同

在Golang实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《gRPC与Swagger所用注释的不同》，聊聊，希望可以帮助到正在努力赚钱的你。

我有一个协议缓冲区定义，其中包括 google.protobuf.timestamp 作为消息的一部分。时间戳消息非常简单，具有以下定义：

message timestamp {
  int64 seconds = 1;
  int32 nanos = 2;
}

因此，grpc 有效负载按照预期作为一个简单的值元组出现。不过，我还想为同一消息的 rest api 生成一些 swagger 注释，但它似乎将时间戳转换为 rfc 3339 样式字符串：

"timestamp": {
  "type": "string",
  "format": "date-time",
  "title": "timestamp"
}

我最近开始使用协议缓冲区和 grpc，所以我不确定我是否在这里遗漏了一些东西，但这似乎与 grpc-gateway 实现不一致。为什么 rest 的格式与 grpc 负载不同？或者我是否缺少某种方法来告诉 protoc-gen-swagger 不要将消息转换为字符串？

解决方案

我对 protoc-gen-swagger 本身不太熟悉，但我相信这是因为这里定义的 json-proto 格式而发生的：

https://developers.google.com/protocol-buffers/docs/proto3#json

这样做是为了让基于 JSON 的 API 更加“自然”。 我不知道有什么方法可以避免这种情况，除了使用您自己的类型来保存时间戳而不是 google.protobuf.Timestamp 。但是，JSON 转换预计可以在两个方向上正常工作，因此当库将 JSON 转换回原始消息时，它不会导致任何问题。

到这里，我们也就讲完了《gRPC与Swagger所用注释的不同》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！