json - 如何在 swagger-spec 中表达 "arbitrary JSON"?

标签 json rest swagger

假设我有一个 REST 服务,它可以接受请求正文中的任意 JSON。我如何使用 swagger-spec 对此进行建模?

我想过Model Objects ,但我只能想到将任意 JSON(作为字符串)包装在容器 JSON 对象中,例如 {"payload": "{ some JSON object serialized to a string }"} ,这不是很有用。

或者,是否有其他方式来表示端点可以在请求正文中接收任意 JSON?

最佳答案

Swagger 在 API 方面试图确定性,因此不直接支持您所要求的内容。

我能想到的唯一方法是将“consumes”属性设置为“application/json”并添加一个字符串类型的“body”参数。这在理论上说应该只发送 JSON,但实际上,可以发送任何字符串。

此外,如果在将字符串发送到服务器之前尝试将字符串转换为 JSON 对象,这可能会破坏某些第三方工具。

关于json - 如何在 swagger-spec 中表达 "arbitrary JSON"?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/25296967/

相关文章:

android - 如何使用 edittext 验证 json 数组

json - 为什么 PostgreSQL 在 jsonb 效率更高时保留 json 字段?

python - 在 swagger python 服务器 stub 处将 token 授权装饰器添加到端点的任何解决方法

javascript - 尝试将获取的 JSON 数据附加到字段,但这不起作用

json - AWS-SDK S3 deleteObjects 返回格式错误的XML?

java - 在 java 中直接从 URL 将文件 POST 到 REST api,而不写入磁盘

java - 如何为具有多种类型的项目设计休息终点?

Rest-Assured - 对于包含路径参数的 Get 请求给出 404 错误

spring - NoSuchMethodError : com. sun.jersey.core.reflection.ReflectionHelper.getOsgiRegistryInstance()Lcom/sun/jersey/core/osgi/OsgiRegistry;

java - Spring Boot Swagger API 不工作