本篇内容主要讲解“SpringBootKnife4j在线API文档框架怎么使用”,感兴趣的朋友不妨来看看。本文介免费云主机域名绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“SpringBootKnife4j在线API文档框架怎么使用”吧!Knife4j是一款基于Swagger 2的在线API文档框架。使用Knife4j的基础步骤:添加依赖在application.properties
/application.yml
中添加配置在项目中添加配置类关于依赖项:注意:以上依赖项的版本是2.0.9
,适用于Spring Boot 2.6以下(不含2.6)版本。关于配置文件中的配置,主要是开启此框架的增强模式(Knife4j定义的概念),需要添加:knife4j.enable=true关于配置类:注意:务必检查以上配置类中的basePackage
属性的值,必须是当前项目中控制器类所在的包!在项目中已经完成以上步骤后,启动项目,打开浏览器,通过http://localhost:8080/doc.html即可访问在线API文档。@Api
:添加在控制器类上此注解的tags
属性,可配置模块名称,可以在模块名称中使用编号,例如:01. 品牌管理模块,最终将按照编号升序排列@ApiOperation
:添加在控制器类中处理请求的方法上此注解的value
属性,可配置业务名称@ApiOperationSupport
:添加在控制器类中处理请求的方法上此注解的order
属性(int
类型),可配置业务的排序序号,最终将升序排列@ApiModelProperty
:添加在POJO类型的属性上此注解的value
属性,可配置参数名称(说明)此注解的required
属性,可配置是否必须提交此参数此注解的example
属性,可配置此请求参数的示例值@ApiImplicitParam
:添加在控制器类中处理请求的方法上,用于对未封装的请求参数添加说明(例如Long id
参数)必须配置此注解的name
属性,取值为方法的参数名称,表示当前注解对哪个参数进行说明此注解的value
属性,可配置参数名称(说明)此注解的required
属性,可配置是否必须提交此参数此注解的dataType
属性,可配置参数的数据类型(例如取值为"long"
)此注解的example
属性,可配置此请求参数的示例值@ApiImplicitParams
:添加在控制器类中处理请求的方法上,此注解的value
属性是@ApiImplicitParam
注解的数组类型,当需要使用@ApiImplicitParam
对多个未封装参数进行说明时,需要将多个@ApiImplicitParam
注解的配置作为当前注解的参数到此,相信大家对“SpringBootKnife4j在线API文档框架怎么使用”有了更深的了解,不妨来实际操作一番吧!这里是百云主机网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!
这篇文章主免费云主机域名要介绍“Vue中的侦听器watch怎么使用”,在日常操作中,相信很多人在Vue中的侦听器watch怎么使用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”Vue中的侦听器watch怎么使用”的疑惑有所帮助!…
免责声明:本站发布的图片视频文字,以转载和分享为主,文章观点不代表本站立场,本站不承担相关法律责任;如果涉及侵权请联系邮箱:360163164@qq.com举报,并提供相关证据,经查实将立刻删除涉嫌侵权内容。