Commit Graph

4 Commits

Author SHA1 Message Date
moyin
aae77866ac docs: 更新API文档,反映HTTP状态码修复
文档更新内容:
- 更新注册接口响应示例,区分400和409状态码
- 添加资源冲突响应示例(用户名、邮箱、手机号已存在)
- 完善OpenAPI文档,添加详细的响应示例
- 更新错误码表格,明确不同错误的状态码
- 添加HTTP状态码测试场景

 修复说明:
- 409 Conflict:用户名/邮箱/手机号已存在
- 400 Bad Request:验证码错误/参数格式错误
- 符合RESTful API规范

 测试验证:
- 邮箱冲突:HTTP 409
- 用户名冲突:HTTP 409
- 验证码错误:HTTP 400

 前端开发者现在可以:
- 根据HTTP状态码进行精确的错误处理
- 移除临时解决方案,使用标准状态码判断
- 提供更好的用户体验和错误提示
2025-12-25 16:32:51 +08:00
moyin
9f606abbb2 chore: 升级版本到1.1.0
版本升级:1.0.0  1.1.0

 新功能:
- 验证码登录功能完整实现
- 支持邮箱和手机号验证码登录
- 新增2个API接口(总计23个)

 文档更新:
- Swagger API文档版本更新
- OpenAPI规范文档更新
- 手动API文档版本更新
- 添加v1.1.0版本更新日志

 技术改进:
- 完善验证码相关错误处理
- 优化API响应格式一致性
- 增强测试覆盖率

 更新内容:
- package.json: 1.0.0  1.1.0
- Swagger配置: 1.0.0  1.1.0
- OpenAPI文档: 1.0.0  1.1.0
- 应用状态接口: 1.0.0  1.1.0
- API文档: 添加v1.1.0更新日志
2025-12-25 16:15:52 +08:00
moyin
7385c63ffd feat(docs): 更新OpenAPI文档,添加验证码登录和完整接口定义
- 添加验证码登录接口:/auth/verification-code-login
- 添加发送登录验证码接口:/auth/send-login-verification-code
- 添加邮箱验证相关接口:send/verify/resend-email-verification
- 添加调试接口:debug-verification-code, debug-clear-throttle
- 添加应用状态接口:GET /
- 完善所有Schema定义和响应格式
- 添加测试模式和限流错误响应
- 确保OpenAPI文档与实际API完全匹配
2025-12-25 16:11:07 +08:00
moyin
1e47c4db60 docs:创建完整的API接口文档
- 创建详细的API接口说明文档
- 提供OpenAPI 3.0规范文件
- 创建Postman测试集合
- 添加API文档使用指南
2025-12-17 15:16:27 +08:00