我的新书《Android App开发入门与实战》已于2020年8月由人民邮电出版社出版,欢迎购买。点击进入详情
1.系列文章
IDEA+SpringBoot+MyBatis Dynamic SQL搭建后台系统
在上面这文章基础上,我们增加Swagger功能。
Swagger可以直接生成接口文档,并且增加注释,开发人员可以直接在网页上调试API接口。
2.pom
集成swagger,需要添加它的依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
3.代码配置
- 首先需要在application里面添加相应的annotation:
@EnableWebMvc
@EnableSwagger2
@SpringBootApplication
public class Application {
- 添加SwaggerConfig文件:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2);
}
@Bean
public InternalResourceViewResolver defaultViewResolver() {
return new InternalResourceViewResolver();
}
}
- swagger的API配置信息
比如ApiOperation这个annotation,value表示这个api的作用,notes表示这个api的详细信息。
@GetMapping("/")
@ApiOperation(value = "获取所有用户")
public List<User> getUsers() {
return userService.selectAll();
}
4.运行
run后,打开:http://localhost:8080/swagger-ui/