Swagger 的使用

1.导入依赖

<!-- 核心包 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
<!-- API获取的包 -->	
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<!-- 官方UI包 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

2.添加配置类

@Configuration    //表明当前类是配置类
@EnableOpenApi    //表示开启生成接口文档功能（只有开启了OpenApi,才可以实现生成接口文档的功能）
public class SwaggerConfig {
    
    @Bean
    public Docket createRestApi() {
    
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis( RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
    
        return new ApiInfoBuilder()
                .title("项目接口文档")//标题
                .description("更多请咨询服务开发者c。")//描述
                .version("1.0")//版本
                .build();
    }
}

3.控制层添加注解

位置	格式
类	@Api(tags = “用户信息管理”)
方法	@ApiOperation(“查询用户”)

Swagger界面