快速入门：使用Spring Boot和Swagger生成API文档

在现代Web开发中，API已经成为了不可或缺的一部分。在构建和维护大型Web应用程序时，API文档是至关重要的。Swagger是一种流行的API文档生成工具，它可以帮助我们自动生成清晰、易于理解的API文档。在本文中，我们将介绍如何使用Spring Boot集成Swagger生成API文档。我们将从添加Swagger依赖开始，一步一步地介绍如何配置Swagger，最终生成自己的API文档。让我们开始吧！

1、添加Swagger依赖

<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>

2、配置Swagger

在WebMvconfig配置文件中加入注解
@EnableSwagger2
@EnableKnife4j

然后添加如下代码块

@Bean
    public Docket createRestApi() {
        // 文档类型
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.guet.exam.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("exam")
                .version("1.0")
                .description("exam接口文档")
                .build();
    }

3、设置静态资源映射

@Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        registry.addResourceHandler("/upload/**").addResourceLocations("classpath:/upload/");
    }

4、添加不需要登录验证的路径

@Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //注册自己的拦截器,并设置拦截的请求路径
        //addPathPatterns为拦截此请求路径的请求
        //excludePathPatterns为不拦截此路径的请求
        registry.addInterceptor(loginInterceptor).addPathPatterns("/*/**")
                .excludePathPatterns("/doc.html").excludePathPatterns("/webjars/**")
                .excludePathPatterns("/swagger-resources").excludePathPatterns("/v2/api-docs");
    }

5、常用注解

@Api：用于对整个API接口进行描述，包括接口名称、描述等信息。
@ApiOperation：用于对单个API接口进行描述，包括接口名称、描述、请求方法等信息。
@ApiParam：用于对接口参数进行描述，包括参数名称、描述、数据类型、是否必传等信息。
@ApiModel：用于对数据模型进行描述，包括模型名称、描述等信息。
@ApiModelProperty：用于对数据模型属性进行描述，包括属性名称、描述、数据类型等信息。
@ApiIgnore：用于忽略某个API接口或参数，不在生成的API文档中显示。

当然，我们最常用的是前两个注解，第一个用在控制器类上，第二个用在单个接口上，如下所示
在这里插入图片描述