1、在控制层中添加注解来描述接口信息如:
2、在方法中配置接口的标题信息
@ApiOperation("查询参数列表")
@ResponseBody
public TableDataInfo list(Config config)
startPage();
return getDataTable(list);
3、在系统工具-系统接口
测试相关接口
注意:SwaggerConfig可以指定根据注解或者包名扫描具体的API
API详细说明
与Controller注解并列使用。 属性配置:
属性名称 | 备注 |
---|---|
value | url的路径值 |
tags | 如果设置这个值、value的值会被覆盖 |
description | 对api资源的描述 |
basePath | 基本路径可以不配置 |
position | 如果配置多个Api 想改变显示的顺序位置 |
produces | For example, "application/json, application/xml" |
consumes | For example, "application/json, application/xml" |
protocols | Possible values: http, https, ws, wss. |
authorizations | 高级特性认证时配置 |
hidden | 配置为true 将在文档中隐藏 |
标记,用在方法上,说明方法的作用,每一个url资源的定义,使用方式:
@ApiOperation("获取用户信息")
与Controller中的方法并列使用,属性配置:
ApiParam
标记,请求属性,使用方式:
与Controller中的方法并列使用,属性配置:
属性名称 | 备注 |
---|---|
name | 属性名称 |
value | 属性值 |
defaultValue | 默认属性值 |
allowableValues | 可以不配置 |
required | 是否属性必填 |
access | 不过多描述 |
allowMultiple | 默认为false |
hidden | 隐藏该属性 |
example | 举例子 |
@ApiResponse(code = 400, message = "查询用户失败")
与Controller中的方法并列使用,属性配置:
ApiResponses
标记,响应集配置,使用方式:
与Controller中的方法并列使用,属性配置:
属性名称 | 备注 |
---|---|
value | 多个ApiResponse配置 |
标记,响应头设置,使用方法
@ResponseHeader(name="head",description="响应头设计")
与Controller中的方法并列使用,属性配置: