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

对象属性

@ApiModelProperty

用在出入参数对象的字段上

作用范围 API 使用位置

对象属性 @ApiModelProperty 用在出入参数对象的字段上

协议集描述 @Api 用于controller类上

协议描述 @ApiOperation 用在controller的方法上

Response集 @ApiResponses 用在controller的方法上

Response @ApiResponse 用在 @ApiResponses里边

非对象参数集 @ApiImplicitParams 用在controller的方法上

非对象参数描述 @ApiImplicitParam 用在@ApiImplicitParams的方法里边

描述返回对象的意义 @ApiModel 用在返回对象类上

@ApiModelProperty()用于方法，字段； 表示对model属性的说明或者数据操作更改 ，可以自动生成为swagger文档的出入参示例
value–字段说明 
name–重写属性名字 
dataType–重写属性类型 
required–是否必填 
example–举例说明 
hidden–隐藏

1 2	@ApiModelProperty(value="用户名",name="username",example="xingguo")           private String username;