Swagger springboot整合swagger

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：参数默认值