Swagger2介绍

chen955

已于 2022-02-17 17:25:17 修改

阅读量916

点赞数

文章标签： java 开发语言后端

于 2021-12-01 17:44:17 首次发布

本文链接：https://blog.csdn.net/chen955/article/details/121660084

版权

本博客介绍了如何在Java后端项目中配置Swagger2，以生成在线接口文档和方便接口测试。通过添加相关依赖，创建配置类，并定义接口及参数说明，实现了Swagger2的集成。

摘要由CSDN通过智能技术生成

Swagger访问路径：http://localhost:8001/swagger-ui.html

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

1.生成在线接口文档

2.方便接口测试

配置Swagger2

1、创建common模块

在guli-parent下创建模块common

配置：

groupId：com.atguigu

artifactId：common

2、在common中引入相关依赖

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<scope>provided </scope>
</dependency>

<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<scope>provided </scope>
</dependency>

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided </scope>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<scope>provided </scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<scope>provided </scope>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

</dependencies>

3、在common下面创建子模块service-base

在模块service-base中，创建swagger的配置类

创建包com.atguigu.servicebase.config，创建类SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {

@Bean
public Docket webApiConfig(){

return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();

}

private ApiInfo webApiInfo(){

return new ApiInfoBuilder()
.title("网站-课程中心API文档")
.description("本文档描述了课程中心微服务接口定义")
.version("1.0")
.contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com"))
.build();
}
}

*配置类写法为固定写法，直接复制粘贴即可

4、在模块service模块中引入service-base

<dependency>
<groupId>com.atguigu</groupId>
<artifactId>service-base</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>

5、在service-edu启动类上添加注解，进行测试

@ComponentScan（basePackages={"com.atguigu"}）主要用于扫描同一前缀名的配置文件

6、定义接口说明和参数说明

定义在类上：@Api

定义在方法上：@ApiOperation

定义在参数上：@ApiParam

@Api(description="讲师管理")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherAdminController {

@Autowired
private TeacherService teacherService;

   @ApiOperation(value = "所有讲师列表")
   @GetMapping
   public List<Teacher> list(){
       return teacherService.list(null);
   }

   @ApiOperation(value = "根据ID删除讲师")
   @DeleteMapping("{id}")
   public boolean removeById(
           @ApiParam(name = "id", value = "讲师ID", required = true)
           @PathVariable String id){
       return teacherService.removeById(id);
   }
}