【问题标题】:Swagger annotations for restful services with JSON data type and without Java Models usage具有 JSON 数据类型且不使用 Java 模型的 RESTful 服务的 Swagger 注释
【发布时间】:2017-05-12 10:25:02
【问题描述】:

我已经为我的休息服务写了这样的招摇注释。

@Post
@Path("/updateDocument")
@ApiOperation(value = "updateDocument", notes = "This will do a checkout and 
checkin services", response = Response.class, responseContainer = "application/json")
@Produces("application/json")
@Consumes("application/json")
public String updateDocument(String data) {
      return data;
}

使用此操作,模型架构在 Swagger UI 上显示为空。除非我创建 Java 模型类,否则不会显示模型模式。 有人可以给出一些想法,如何获取 JSON 数据类型的 Schema 定义?我的 Restful 服务接受 JSON 并在不使用任何 Java 模型的情况下处理 JSON。

使用 Java 模型,需要对数据进行不必要的转换。

是否可以创建和链接 JSON 定义文件而不是 Java 模型?

非常感谢任何帮助。

【问题讨论】:

    标签: java json rest swagger


    【解决方案1】:

    根据您的方法声明,它需要 String 作为参数。这就是招摇能读的全部内容。它怎么知道这个 String 可以是 json 并且可以是 xyz 结构。所以它不能显示你的模型模式,除非你指定一个 Java 模型

    【讨论】:

    • 嗨@pvpkiran,感谢您的回复。是否可以在swagger2 annotations 中链接外部定义的开放 API 模式定义?如果需要,我可以使用开放 API 定义 JSON Schema definitions 并在 Java 文件之外进行维护。如果有任何可能,你能告诉我吗?
    猜你喜欢
    • 2013-09-17
    • 1970-01-01
    • 2019-01-22
    • 2022-08-05
    • 2016-07-20
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2023-04-09
    相关资源
    最近更新 更多