Spring Boot整合Swagger2搭建Restful API線上文件

整合Swagger2步驟：
    1. pom檔案新增引用：
                <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>

    2. 配置Swagger2

       A. 寫一個配置類Swagger2 ，在類的上方加上@Configuration 註解， 表明是一個配置類，加上@EnableSwagger2 開啟Swagger2 的功能。
        在配置類Swagger2 中需要注入一個Docket 的Bean ， 該Bean 包含了apiInfo ，即基本API 文件的描述資訊，以及包掃描的基本包名等資訊。


    
 
3. 寫生成文件的註解
       Swagger2 通過註解來生成API 介面文件，文件資訊包括介面名、請求方法、引數、返回資訊等。通常’悄況下用於生成線上API 文件，以下的註解能夠滿足基本需求，註解及其描述如下。
       口@Api ： 修飾整個類，用於描述Controller 類。
       口@ApiOperation ：描述類的方法，或者說一個介面。
       口@ApiParam ： 單個引數描述。
       口@ApiModel ：用物件來接收引數。
       口@ApiProperty ：用物件接收引數時，描述物件的一個欄位。
       口@ApiResponse: HTTP 響應的一個描述。
       口@ApiResponses: HTTP 響應的整體描述。
       口@Apilgnore ：使用該註解，表示Swagger2 忽略這個API 。
       口@ApiError ： 發生錯誤返回的資訊。
       口@ApiParamlmplicit ： 一個請求引數。
       口@ApiParamsimplicit ： 多個請求引數。

    
 
4. 建立Service層程式碼 

    5. 建立Controller  
        通過@ApiOperation 註解描述生成線上文件的具體API 的說明，其中value 值為該介面的名稱，notes 值為該介面的詳細文件說明。這樣就可以讓Swagger2 生成線上的API 介面文件了。
        如果不需要某接扣生成文擋，只市要再加@Apilgnore 註解即可。

    6. 啟動服務，瀏覽器訪問： http://localhost:8080/swagger-ui.html 檢視線上API