0-前言
集成swagger,有两种方式:
一种在前面已经介绍过了,直接集成官方的springfox-swagger2的方式,这种方式需要在配置类中配置
第二种方式是这里要介绍的方式,国人写的com.spring4all的方式,这种方式其实是对第一种方式的进一步封装,
只是把配置从配置类中配置提取到了在配置文件配置,看个人喜好了,你喜欢在配置文件中配置swagger基本属性的可以用com.spring4all
1-实现
简单4步轻松实现:
1-1、添加依赖:
<!-- swagger --> <dependency> <groupId>com.spring4all</groupId> <artifactId>swagger-spring-boot-starter</artifactId> <version>1.9.1.RELEASE</version> </dependency>
1-2、启动类中添加注解
@EnableSwagger2Doc
1-3、配置文件中添加配置
区别其实也主要在这里,以前我们是写死在配置类种的,现在可以在配置文件中配置,好处是可以不需要变动程序,随时更改;
#swagger配置 swagger: enable: true title: OSS服务 description: OSS基础服务API version: ${project.version} base-package: com.example.oss base-path: /** exclude-path: /error authorization: key-name: Authorization
1-4、使用
跟以前的方式是一样的
@GetMapping("/getmsg") @ApiOperation(value = "I18N", notes = "获取I18N值") public String language() { String message =LocalUtil.get("user.appname"); return message; }
完毕,萝卜青菜,各有所爱,你喜欢在配置类中来写,还是在配置文件来配置,看个人喜欢来自己选择;
实际项目上线的时候,swagger一般都是要关闭的,所以其实哪种都一样的;
就我而言,更喜欢在配置类中来写,这样不会污染配置文件;
配置文件是贯穿我们项目整个生命周期的,与上线无关的配置我们都不希望在配置文件中出现;
当然,看个人喜欢;