首页 > 解决方案 > Swagger - 描述 JSON 有效负载字段

问题描述

在使用 Swagger 的 REST 服务中,我有类似的东西
public UserResponse createUser(@RequestBody CreateUserRequest request)

CreateUserRequest是一个 POJO/bean。
它由调用者作为 JSON 传入。

是否有任何 Swagger 注释来描述:
a) POJO 的哪些字段是必需的,哪些是可选的
b) POJO 字段的默认值

我发现了这样的注释,例如 GET 参数,但是如果我需要描述 JSON 有效负载/正文怎么办?

我只使用注释,没有大张旗鼓的 YAML。

标签: javarestswagger

解决方案


查看注释@ApiModelProperty,检查 swagger wiki 以获取所有注释swagger-annotations


推荐阅读