Swagger是一個簡單但功能強大的API表達工具,使用Swagger生成API，我們可以得到互動式文件。

pom.xml中依賴引入如下:

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>
 

swagger的版本可以根據${swagger.version}引數按需配置,我的習慣是一般都用最新的

@ApiOperation：表示方法作用

@ApiImplicitParams：表示方法上的一組引數

@ApiImplicitParam：在@ApiImplicitParams註解中表示單個請求引數

 其中，ApiImplicitParam中又包括如下引數

1.paramType：引數來源

                      1.header ：@RequestHeader

                      2.query ：@RequestParam

                      3.path（用於restful介面）：@PathVariable

                      4.body ：@RequestBody

                      5.form ：表單提交

2.name：引數名

3.dataType：引數資料型別

4.required：引數必要性

5.value：引數含義

6.defaultValue：引數預設值