style: 统一请求参数、响应参数注释

This commit is contained in:
2025-04-17 21:57:09 +08:00
parent 1c85b43931
commit bf3e1590fa
9 changed files with 29 additions and 26 deletions

View File

@@ -131,12 +131,13 @@ public class CaptchaController {
* <p>
* 限流规则:<br>
* 1.同一邮箱同一模板1分钟2条1小时8条24小时20条 <br>
* 2同一邮箱所有模板 24 小时 100 条 <br>
* 3同一 IP 每分钟限制发送 30 条
* 2.同一邮箱所有模板 24 小时 100 条 <br>
* 3.同一 IP 每分钟限制发送 30 条
* </p>
*
* @param email 邮箱
* @return /
* @param email 邮箱
* @param captchaReq 行为验证码请求参数
* @return {@link R }
*/
@Operation(summary = "获取邮箱验证码", description = "发送验证码到指定邮箱")
@GetMapping("/mail")
@@ -177,13 +178,13 @@ public class CaptchaController {
* <p>
* 限流规则:<br>
* 1.同一号码同一模板1分钟2条1小时8条24小时20条 <br>
* 2同一号码所有模板 24 小时 100 条 <br>
* 3同一 IP 每分钟限制发送 30 条
* 2.同一号码所有模板 24 小时 100 条 <br>
* 3.同一 IP 每分钟限制发送 30 条
* </p>
*
* @param phone 手机号
* @param captchaReq 行为验证码信息
* @return /
* @param captchaReq 行为验证码请求参数
* @return {@link R }
*/
@Operation(summary = "获取短信验证码", description = "发送验证码到指定手机号")
@GetMapping("/sms")