1、在控制层中添加注解来描述接口信息如:

2、在方法中配置接口的标题信息

@ApiOperation("查询参数列表")@ResponseBodypublic TableDataInfo list(Config config) startPage(); return getDataTable(list);

3、在系统工具-系统接口测试相关接口

注意：SwaggerConfig可以指定根据注解或者包名扫描具体的API

API详细说明

与Controller注解并列使用。 属性配置：

属性名称备注valueurl的路径值tags如果设置这个值、value的值会被覆盖description对api资源的描述basePath基本路径可以不配置position如果配置多个Api 想改变显示的顺序位置producesFor example, "application/json, application/xml"consumesFor example, "application/json, application/xml"protocolsPossible values: http, https, ws, wss.authorizations高级特性认证时配置hidden配置为true 将在文档中隐藏

标记，用在方法上，说明方法的作用，每一个url资源的定义,使用方式：

@ApiOperation("获取用户信息")

与Controller中的方法并列使用，属性配置：

ApiParam标记，请求属性，使用方式：

与Controller中的方法并列使用，属性配置：

属性名称备注name属性名称value属性值defaultValue默认属性值allowableValues可以不配置required是否属性必填access不过多描述allowMultiple默认为falsehidden隐藏该属性example举例子

@ApiResponse(code = 400, message = "查询用户失败")

与Controller中的方法并列使用，属性配置：

ApiResponses标记，响应集配置，使用方式:

与Controller中的方法并列使用，属性配置：

属性名称备注value多个ApiResponse配置

标记，响应头设置，使用方法

@ResponseHeader(name="head",description="响应头设计")

与Controller中的方法并列使用，属性配置：