Spring Boot 中使用 Swagger _生活百科

前后端分离开发，后端需要编写接?说明?档，会耗费?较多的时间。swagger 是?个?于?成服务器接?的规范性?档，并且能够对接?进?测试的?具。

作用

?成接?说明?档
对接?进?测试

使用步骤

添加依赖
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>
写配置类 SwaggerConfig
/** * SwaggerConfig 接口文档配置类 */@Configuration@EnableSwagger2public class SwaggerConfig {/*** 配置接口文档生成规则*/@Beanpublic Docket getDocket() {// 设置文档生成规则return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) // 设置文档信息.select()// 设置哪个包下的类需要生成文档.apis(RequestHandlerSelectors.basePackage("com.luis.fmmall.controller")).paths(PathSelectors.any()) // 定义哪些路径的接口需要生成文档.build();}/*** 设置文档信息*/private ApiInfo apiInfo() {return new ApiInfoBuilder().title("xxx接口文档").description("这里是相关描述").version("1.0").contact(new Contact("luis","https://www.cnblogs.com/luisblog","xxx@qq.com")).build();}}
在控制器类上使用 Swagger 的注解进行相关说明
示例如下：
@RestController@RequestMapping("/user")@Api(tags = "用户管理", value = "https://www.huyubaike.com/biancheng/提供用户的登陆、注册、修改等功能") //类说明public class UserController {@Resourceprivate UserService userService;@GetMapping("/login")@ApiOperation(value = "https://www.huyubaike.com/biancheng/登陆验证", notes = "用户登陆检查") //方法名说明@ApiImplicitParams({ //参数说明@ApiImplicitParam(dataType = "string", name = "username", value = "https://www.huyubaike.com/biancheng/用户名", required = true),@ApiImplicitParam(dataType = "string", name = "password", value = "https://www.huyubaike.com/biancheng/用户密码", required = false, defaultValue = "https://www.huyubaike.com/biancheng/123")})public ResultVo login(@RequestParam("username") String name,@RequestParam(value = "https://www.huyubaike.com/biancheng/password", defaultValue = "https://www.huyubaike.com/biancheng/123") String pwd) {return userService.checkLogin(name, pwd);}}
启动 SpringBoot 应用，访问 http://localhost:8080/swagger-ui.html
效果如下：

文章插图

常用注解说明

@Api：类注解，使用在控制器类上，对类进行说明
控制器类 UserController 示例：
@Api(tags = "用户管理", value = "https://www.huyubaike.com/biancheng/提供用户的登陆、注册、修改等功能") //类说明public class UserController {}
@ApiOperation：方法注解，使用在方法上，对方法名进行说明
@ApiImplicitParam 和 @ApiImplicitParams：方法注解，使用在方法上，对方法的形参进行说明
单个形参使用 @ApiImplicitParam，多个形参使用 @ApiImplicitParams
控制器类 UserController 的 login 方法示例：
@GetMapping("/login")@ApiOperation(value = "https://www.huyubaike.com/biancheng/登陆验证", notes = "用户登陆检查") //方法名说明@ApiImplicitParams({ //参数说明@ApiImplicitParam(dataType = "string", name = "username", value = "https://www.huyubaike.com/biancheng/用户名", required = true),@ApiImplicitParam(dataType = "string", name = "password", value = "https://www.huyubaike.com/biancheng/用户密码", required = false, defaultValue = "https://www.huyubaike.com/biancheng/123")})public ResultVo login(@RequestParam("username") String name,@RequestParam(value = "https://www.huyubaike.com/biancheng/password", defaultValue = "https://www.huyubaike.com/biancheng/123") String pwd) {return userService.checkLogin(name, pwd);} 上一页 1 2 下一页经验总结扩展阅读信托是什么? 粉蒸肉一直用大火蒸多久,粉蒸肉用普通锅蒸多久 2022年如虎添翼的星座处女座完美主义 2022年12月3日求神拜佛好吗 2022年12月3日求神拜佛好不好内衣老是长霉点还能穿吗暴力熊和kaws是一个吗盘点：你所不知道的高山族的传说接下来事业腾达运势上升人生上吉的3星座泡沫说情感|心理学：凭感觉选一朵蘑菇，测你未来会靠什么发家致富? 马丽|马丽也逃不过“中年发福”？穿白衬衫身材圆润不少，连气质都变了鲍里斯·约翰逊|乌克兰本已准备好和谈，却遭英前首相约翰逊竭力阻拦周朝多少年周朝简介我是文食肆|人生不顺时，默念三句话，你会越来越强大！仅此而已是什么意思仅此而已的意思微信语音为什么没有声音,为什么微信语音没有声音？ 2022年农历九月廿三祭祀灶神吉日 2022年10月18日适合祭祀灶神吗唇珠怎么做不用打针也可以熊猫医学社|40岁男子转氨酶280，确诊肝硬化，医生咆哮：3个习惯，是“祸根” 重度污染天气是什么? 2023年农历八月初四宜认干儿子吗 2023年9月18日认干儿子好不好怎么洗面筋中国全屋定制十大名牌排名中国十大名牌家具排名中国皮床十大名牌排名防盗门哪个牌子质量好中国十大防盗门品牌排行中国十大盆景排名名贵盆景有哪些中元节包袱称呼梦幻模拟战壳中少女技能是什么原神3.0新敌人有哪些全球软床十大顶级品牌

Spring Boot 中使用 Swagger

经验总结扩展阅读