生成接口文档

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