SpringBoot集成Swagger2简单使用-V1.0

1 新建SpringBoot项目 。

2 加入Swagger2依赖 。

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

3 编写配置类MySwagger2Config 。

@Configuration
@EnableSwagger2
public class Swagger2Config {
    
    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("WebApi")  // 分组名
                .apiInfo(apiInfo()) //详细信息
                .select() //所有
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Java张绍API文档")//接口文档名字
                .description("描述服务端的 api 接口定义")//文档描述
                .version("1.0")
                // 加入个人信息  可有可无
                .contact(new Contact("javaZS", "https://i.csdn.net/#/user-center/profile?spm=1000.2115.3001.5111", "1505409172.@qq.com"))
                .build();
    }
}

4 开始使用， 地址栏输入   http://localhost:8080/swagger-ui.html

可能使用到的注解：

@ApiModel(value="Chapter对象", description="课程")  -类上

@ApiModelProperty(value = "章节ID") -实体类属性上

@Api(description = "课程管理") -controller 层类上

@ApiOperation("新增课程") -controller 层方法上

@ApiParam(value = "课程信息对象", required = true) -controller 层方法参数上