SpringBoot2x整合swagger2,可以更加方便梳理接口文档和接口调用,使用起来非常方便,下面整合开始。
1、pom
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
2、xml
spring:
# swagger2 配置
mvc:
pathmatch:
matching-strategy: ant_path_matcher
3、启动类
@EnableSwagger2
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class, DruidDataSourceAutoConfigure.class})
public class SpringbootSingleServerApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootSingleServerApplication.class, args);
}
}
4、控制层
@Api(tags = "任务信息")
@RestController
@RequiredArgsConstructor
@RequestMapping("/task")
public class XxxxxController {
private static Logger logger = LoggerFactory.getLogger(XxxxxController .class);
private final IxxxxService xxxxService;
@ApiOperation(value = "数据库名字集合接口" , notes = "数据库名字集合接口")
@GetMapping("/nameList")
public Result tasksInfo(){
try {
return Result.ok(xxxxService.findDatabasesName());
} catch (Exception e) {
logger.error("查询数据库名字集合出现异常:{}",e.getMessage(),e);
return Result.failed("查询数据库名字集合出现异常");
}
}
4、访问 http://localhost:8099/swagger-ui.html
找到需要测试的接口,配置好输入的参数,点击执行,接口调用此接口。