SpringBoot 集成Swagger2

一、使用swagger的好处：   

    Swagger是一个自动的API接口文档生成器，使用Swagger可以简化接口文档编写的工作大大地提升开发效率。

二、Swager2常用注解：

        @Api：修饰整个类，描述Controller的作用
        @ApiOperation：描述一个类的一个方法，或者说一个接口
        @ApiParam：单个参数描述
        @ApiModel：用对象来接收参数
        @ApiModelProperty：用对象接收参数时，描述对象的一个字段
        @ApiImplicitParam：一个请求参数
        @ApiImplicitParams：多个请求参数

三、集成swagger2到SpringBoot项目中：

 1、pom.xml文件中引入相关依赖:：

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-boot-starter</artifactId>
	<version>3.0.0</version>
</dependency>

2、添加配置类Swagger2Config：

@Configuration
@EnableSwagger2
public class Swagger2Config {

    /**
     * Swagger2核心配置
     * @return
     */
    @Bean
    public Docket webApiDocket() {
        return new Docket(DocumentationType.SWAGGER_2)  // 指定api类型为swagger2
                .groupName("webApi")
                .apiInfo(this.webApiInfo())  // API文档信息
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)) // 带有RestController注解的类
                .paths(PathSelectors.any()) // 匹配所有URL
                .build();
    }

    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger API 中心")
                .description("spring boot 从零开始")
                .contact(new Contact("张三","http://example.com","example@aa.com"))
                .version("1.0").build();
    }

}

3、启动项目进入swagger-ui：

 

注意：SpringBoot 版本在2.6.x以上是会报错，建议使用2.6.x以下版本。