接口注解
我的CSDN:https://blog.csdn.net/weixin_43438052/article/details/113705705
Swagger
@Api
- 用于
类
上,标识这个类是swagger
的资源 - 用在
类
上,说明该类的作用
@Api(value = "说明", tags = {"标签"})
value
可以用tags
代替
tags
如果有多个值,会生成多个list
- 实例
@Api(value = "品类表", tags = {"category"})
@RestController
@RequestMapping("/category")
public class CategoryController {
}
@ApiOperation
- 用在
方法
上 - 表示
一个http请求的操作
@ApiOperation(value = "接口说明", httpMethod = "接口请求方式", response = 接口返回参数类型.class, notes = "接口发布说明", tags = {""});
tags
如果有多个值,会生成多个list
- 实例
@ApiOperation(value = "获取完整品类信息list", httpMethod = "GET", response = Category.class, notes = "返回的是所有完整的品类信息", tags = {"1","2"})
@ApiParam
@ApiParam(required = false, name = "参数名称", value = "参数具体描述")
required
:是否必须参数
false
true
- 实例
@ApiOperation(value = "新增品类", httpMethod = "POST", notes = "必须,传入json格式数据", tags = {"category","insert"})
@PostMapping("addNewCategory")
public ResultVO addNewCategory(@ApiParam(required = true, name = "json", value = "json格式,必须,非空") @RequestBody Category category) {
return ResultVO.ok(categoryService.addNewCategory(category));
}
Spring
@RestController
@Autowired
@RequestMapping
@GetMapping
DeleteMapper
@Transactional
@RequestParam
@RequestParam("id")
@RequestBody
@RequestBody(required = false)
用到@RequestBody,必须使用@RequestBody。需要提交一个Json对象上去。
💥 一个正在学习全栈的 💥
⭐ 精神小伙 ⭐
💥 MelodyJerry 💥