SpringBoot整合Swagger接口文档

一、什么是swagger

它就是一个api接口，它可以对你书写的接口进行说明。并以文档的形式存在。

二、如何使用swagger

(1)引入swagger依赖

<!--swagger的依赖引入-->
        <dependency>
            <groupId>io.github.jianzhichun</groupId>
            <artifactId>spring-boot-starter-swagger2</artifactId>
            <version>0.1.2</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

（2）配置swagger的信息

@Configuration //表示类似与配置文件
public class SwaggerConfig {

    @Bean //加在方法上，表示吧方法的返回结果交于spring容器来管理该对象. 里面封装了接口文档的信息，
    public Docket docket(){
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .groupName("aaa")
                .apiInfo(getInfo())
                .select()
                //只为com.aaa.controller包下的类生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.aaa.controller"))
                .build();
        return docket;
    }

    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("张三", "http://www.jd.com", "666@qq.com");
        ApiInfo apiInfo= new ApiInfo("员工管理系统API文档", "员工管理系统API文档",
                "1.5", "localhost:8080/doc.html", DEFAULT_CONTACT, "ABC科技有限公司", "http://www.baidu.com");
        return apiInfo;
    }
}

三、启动工程并访问swagger接口文档的路径

有如下两种访问方式：

（1）http://ip:port/swagger-ui.html

（2）http://ip:port/doc.html

 

四、swagger注解使用详情

注解	用法
@Api(tags=" ")	加在接口类上，它是对接口类的说明
@ApiOperation(value=" ")	加在接口方法上，它是对接口方法的说明
@ApiImplicitParam	它是对单个参数的说明
@ApiImplicitParams	它是对接口所有参数的说明
@ApiModel	它是对实体类的说明
@ApiModelProperty	它是对实体类中属性的说明