返回介绍

文档

中间件

OAS 简介

实战指南

3.16 动态响应参数添加文档注释

发布于 2022-12-06 22:06:14 字数 1183 浏览 0 评论 0 收藏 0

温馨提醒

增强功能需要通过配置yml配置文件开启增强,自2.0.6开始

knife4j:
enable: true

动态响应参数其实和动态请求参数添加注释类似

同样使用 Knife4j 提供的增强注解 @DynamicResponseParameters ,代码示例如下:

@PostMapping("/createOrder426")
@ApiOperation(value = "jdk-HashMap-动态创建显示参数-无@RequestBody")
@DynamicResponseParameters(name = "CreateOrderHashMapModel",properties = {
@DynamicParameter(name = "",value = "注解id",example = "X000111",required = true,dataTypeClass = Integer.class),
@DynamicParameter(name = "name3",value = "订单编号-gson"),
@DynamicParameter(name = "name1",value = "订单编号1-gson"),
})
public Rest<HashMap> createOrder1235332(@RequestBody HashMap map){
Rest<HashMap> r=new Rest<>();
r.setData(map);
return r;
}

注解 @DynamicResponseParameters 中有一个name属性,该值开发者可以理解为一个类名,如果你赋予name属性值,那么请保证全局唯一,或者干脆不赋值,交给 Knife4j 自动生成一个全局唯一的name值

同样对于数组、泛型等复杂的类型暂不提供支持。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文