@RestController
注解表明这是一个 RESTful Web 服务的控制器。@RequestMapping(value = "/pathOfCtrl")
定义了该控制器的基本 URL 路径。@module
标签指定 API 所属的项目。
methodName1
)通常用作 API 操作的标识符。@RequestMapping
和方法级别的@RequestMapping
(或@GetMapping
, @PostMapping
等)组合而成。/pathOfCtrl/pathOfApi1
@RequestMapping(method = RequestMethod.POST)
或直接使用@PostMapping
等指定@param
标签中提取@RequestParam(required = false)
表示可选参数defaultValue
属性指定默认值@return
Javadoc 标签中提取响应描述
query
@RequestBody
注解时,Apifox helper 会自动识别并设置 Content-Type 为application/json
。@Deprecated
注解或@deprecated
Javadoc 标签来标记将废弃的 API: