java - Swagger - 描述 JSON 有效负载字段
问题描述
在使用 Swagger 的 REST 服务中,我有类似的东西
public UserResponse createUser(@RequestBody CreateUserRequest request)
这CreateUserRequest
是一个 POJO/bean。
它由调用者作为 JSON 传入。
是否有任何 Swagger 注释来描述:
a) POJO 的哪些字段是必需的,哪些是可选的
b) POJO 字段的默认值
我发现了这样的注释,例如 GET 参数,但是如果我需要描述 JSON 有效负载/正文怎么办?
我只使用注释,没有大张旗鼓的 YAML。
解决方案
查看注释@ApiModelProperty,检查 swagger wiki 以获取所有注释swagger-annotations
推荐阅读
- arrays - 给定两个未排序的数组 A 和 B ,找到一对元素的和(或差)等于给定的 k - 通过仅对其中一个数组进行排序
- mysql - 对酒店应用程序具有特定偏好的房间的 SQL 查询
- node.js - 请求不会通过 api 路径
- java - 无法解决 NoSuchElementException
- shell - 在 perl 中将命令输出写入 csv 文件
- python - Tensorflow:不同的占位符会导致不同的模型性能
- rest - JAX-RS REST:根据 MediaType 参数路由 HTTP 请求
- java - 使用蓝牙在 Android 应用程序之间交换消息
- c++ - 初始化非整数的巨大常量多维数组的最佳方法是什么?
- jenkins - Jenkins活动目录找不到匹配的构造函数