docs: 更新API文档,反映HTTP状态码修复
文档更新内容: - 更新注册接口响应示例,区分400和409状态码 - 添加资源冲突响应示例(用户名、邮箱、手机号已存在) - 完善OpenAPI文档,添加详细的响应示例 - 更新错误码表格,明确不同错误的状态码 - 添加HTTP状态码测试场景 修复说明: - 409 Conflict:用户名/邮箱/手机号已存在 - 400 Bad Request:验证码错误/参数格式错误 - 符合RESTful API规范 测试验证: - 邮箱冲突:HTTP 409 - 用户名冲突:HTTP 409 - 验证码错误:HTTP 400 前端开发者现在可以: - 根据HTTP状态码进行精确的错误处理 - 移除临时解决方案,使用标准状态码判断 - 提供更好的用户体验和错误提示
This commit is contained in:
@@ -128,17 +128,49 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RegisterResponse'
|
||||
'400':
|
||||
description: 请求参数错误
|
||||
description: 请求参数错误或验证码错误
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
examples:
|
||||
validation_error:
|
||||
summary: 参数验证错误
|
||||
value:
|
||||
success: false
|
||||
message: "密码必须包含字母和数字,长度8-128字符"
|
||||
error_code: "REGISTER_FAILED"
|
||||
verification_code_error:
|
||||
summary: 验证码错误
|
||||
value:
|
||||
success: false
|
||||
message: "验证码不存在或已过期"
|
||||
error_code: "REGISTER_FAILED"
|
||||
'409':
|
||||
description: 用户名或邮箱已存在
|
||||
description: 资源冲突 - 用户名、邮箱或手机号已存在
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
examples:
|
||||
username_exists:
|
||||
summary: 用户名已存在
|
||||
value:
|
||||
success: false
|
||||
message: "用户名已存在"
|
||||
error_code: "REGISTER_FAILED"
|
||||
email_exists:
|
||||
summary: 邮箱已存在
|
||||
value:
|
||||
success: false
|
||||
message: "邮箱已存在"
|
||||
error_code: "REGISTER_FAILED"
|
||||
phone_exists:
|
||||
summary: 手机号已存在
|
||||
value:
|
||||
success: false
|
||||
message: "手机号已存在"
|
||||
error_code: "REGISTER_FAILED"
|
||||
|
||||
/auth/github:
|
||||
post:
|
||||
|
||||
Reference in New Issue
Block a user