json - 如何使用 Swagger 2.0 或 OpenApi 3.x 在 API 对象中指定 "JSON Raw Message"?

标签 json go swagger-2.0 openapi

我正在使用 Swagger 2.0 记录 REST API(用 Go 开发),API 响应使用的结构之一包括几个在 Go 中声明为“Json.RawMessage”类型的字段。我在 Swagger 规范中找不到任何合适的“数据类型”来涵盖这一点。我能想象的最接近的是“字节”格式的字符串。但这还差得很远。任何想法都会有很大帮助。

最佳答案

json.RawMessage只是解析 json 消息的方式。它允许延迟解析某些字段或所有消息。

它不会影响响应的结构或格式,因此您无需以任何方式在 openapi 规范中指定它。

我唯一能猜测的是,某些字段可能具有不同的架构,从一个响应到另一个响应。所以你不能同时记录所有这些(据我所知openapi功能),你所能做的就是将其描述为一般的“object”。并在文档中的某处描述可能的模式。

关于json - 如何使用 Swagger 2.0 或 OpenApi 3.x 在 API 对象中指定 "JSON Raw Message"?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/59245851/

相关文章:

jquery - 如何获取这个复杂 JSON 对象中的 ISBN_10 标识符

php - 在 PHP5.1.6 上运行时获取 json 为 null 输出

go - 缩进包含 JSON 类数据的字符串

Go——优雅地处理多个错误?

swagger - 如何指定一个属性可以是空的,也可以是带有 Swagger 的引用

JSONRPC 服务器返回空结果

javascript - 正则表达式转义双引号内的双引号

go - 在不改变 float 的情况下将 float 转换为字符串

odata - 如何记录 OData 端点(swagger、swashbuckle、其他)?

asp.net-web-api2 - Swashbuckle Swagger-如何注释内容类型?