springboot集成swagger2

一、swagger简介

在日常的工作中，我们往往需要给前端（WEB端、IOS、Android）或者第三方提供接口，
这个时候我们就需要给他们提供一份详细的API说明文档。但维护一份详细的文档可不是一件简单的事情。
首先，编写一份详细的文档本身就是一件很费时费力的事情，另一方面，由于代码和文档是分离的，
所以很容易导致文档和代码的不一致。这篇文章我们就来分享一种API文档维护的方式，
即通过Swagger来自动生成Restuful API文档。
　　
那什么是Swagger？我们可以直接看下官方的描述：
THE WORLD'S MOST POPULAR API TOOLING
Swagger is the world's largest framework of API developer tools for the OpenAPI Specification(OAS),
enabling development across the entire API lifecycle, from design and documentation, 
to test and deployment.
这段话首先告诉大家Swagger是世界上最流行的API工具，并且Swagger的目的是支撑整个API生命周期的开发，包括设计、文档以及测试和部署

二、 springboot集成

添加依赖
     <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.6.1</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.6.1</version>
    </dependency>


//注解开启 swagger2 功能
@Configuration
@EnableSwagger2
public class Swagger2Config {

/**
 * 通过 createRestApi函数来构建一个DocketBean
 */
@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())//调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.lzh.swagger2"))
            .paths(PathSelectors.any())
            .build();
}

//构建 api文档的详细信息函数
private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            //页面标题
            .title("Swagger2 测试")
            //创建人
            .contact(new Contact("lzh","",""))
            //版本号
            .version("1.0")
            //描述
            .description("API 描述")
            .build();
}
}

三、 swagger 常用注解

controller 常用注解说明:
        /**
         * @ApiOperation，整个接口属性配置：
         * 　　　　value：接口说明，展示在接口列表。
         * 　　　　notes：接口详细说明，展示在接口的详情页。
         * 　　　　tags：接口的标签，相同标签的接口会在一个标签页下展示。
         * 　　　　httpMethod：支持的HTTP的方法。
         * @ApiImplicitParams，@ApiImplicitParam的容器，可包含多个@ApiImplicitParam注解
         * @ApiImplicitParam，请求参数属性配置：
         * 　　　　name：参数名称
         * 　　　　value：参数说明
         * 　　　　required：是否必须
         * 　　　　dataType：数据类型　
         *
         * @ApiParam   请求参数 入参实体类只有加上这个注解才能再页面上显示
         *        name：参数名称
         *   　　 value：参数说明
         *        required：是否必须 　
         */


model vo 常用注解说明:

        /**
         * 　@ApiModel是对整个类的属性的配置：
         * 　　　　value：类的说明
         * 　　　　description：详细描述
         * 　@ApiModelProperty是对具体每个字段的属性配置：
         * 　　　　name：字段名称
         * 　　　　value：字段的说明
         * 　　　　required：是否必须
         * 　　　　example：示例值
         * 　　　　hidden：是否显示
         */

四、jrebel热部署使用

参考链接:https://blog.csdn.net/Hello_l/article/details/80009516

补充关键步骤：
        jreble 激活
        启动 下载下来的可执行文件文件
        http://127.0.0.1:8888/GUID  
        GUID 随便找个网址在线生成
        邮箱随便写

五、xrebel的使用

参考链接:http://blog.lanyus.com/archives/150.html
官网下载
在服务器添加 VM参数 -javaagent:D:\xrebel.jar

激活服务器: 与jrebel激活一样 本地地理服务器