swagger注解文档

swagger注解详情

1. @Api()

作用于类，放置于controller的一个类上，标志这个类是swagger资源

1.1参数：

参数名称	参数介绍	备注
value	说明，可以使用tags替代
tags	说明

1.2实例代码：

@Api(value = "swagger2测试api", tags = "管理员")
@RequestMapping("/api/admin")
public interface AdminFeign {
   
  
}

1.3示例图：

2. @ApiOperation()

作用于方法之上，用户表示一个http的请求

2.1 参数

参数名称	参数介绍	备注
value	方法描述
notes	方法描述详情
tags	标签，可继承类的标签	可不填
response	返回类型	class，可不填
httpMethod	请求方法	get，post等，可不填

2.2 示例代码

@ApiOperation(value = "添加管理员", notes = "查询数据库中某个的学生信息")
@RequestMapping