diff --git a/docs/api doc/用户登录接口.md b/docs/api doc/用户登录接口.md new file mode 100644 index 0000000..940cdf9 --- /dev/null +++ b/docs/api doc/用户登录接口.md @@ -0,0 +1,77 @@ +# RESTFul API 文档 v1.0 + +## 1. 用户注册 + +### 1.1 接口描述 +用户输入账号、邮箱、密码完成注册。 +### 1.2 请求URL +`/v1/auth/register` + +### 1.3 请求方式 +**POST** + +### 1.4 请求头 +| 头字段 | 必填 | 数据类型 | 描述 | +| ------------ | ---- | ------------- | -------------------------------- | +| Content-Type | 是 | application/json | 指定请求体的媒体类型为JSON | + +### 1.5 请求体参数 +| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 | 示例 | 允许空值 | +|-----------| ---- | -------- | -------- | ---------------------------- | ------------ | -------- | +| username | 是 | 字符串 | 1-50字符 | 用于登录的账号(手机号或邮箱) | "user123" | 否 | +| password | 是 | 字符串 | 1-50字符 | 密码 | "p@ssw0rd" | 否 | + + +### 1.6 请求示例 +```http +POST /api/user/signup +Host: {apiAddress} +Content-Type: application/json + +{ + "username": "a123", + "password": "123456" +} +``` + +### 1.7 返回参数说明 +| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 | +|-----------| ---- | -------- | -------- | ---------------------------- | +| code | 是 | 整型 | | 错误码,200表示成功 | +| message | 否 | 字符串 | 1-50字符 | 错误信息描述 | +| data | 否 | json | | 具体业务数据 | + + +### 1.8 响应示例(成功) + +```json + {"code":0,"msg":"success","data":{"id":100067,"username":"a123"}} +``` +### 1.9 响应示例(错误) +```json +{ "code": 10001, "message": "验证码无效" } +``` + +### 1.10 错误响应码参考 +更多响应错误码及含义,请参阅[API响应码表](URL/for/api/responseCode/table)。 + +### 1.11 安全性与认证 + + +### 1.12 测试环境 +访问测试环境以进行接口调试: +[https://test.apiAddress.com](https://test.apiAddress.com) + +### 1.13 版本管理 +本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。 + +### 1.14 更新记录 +- **2024-04-29**:发布文档初始版本。 + + +### 1.15 联系支持 +如需帮助或对API有任何疑问,请通过电子邮件与我们联系:[support@api.com](mailto:support@api.com)。 + +### 1.16 反馈与建议 +发现文档问题或有改进建议?请填写[反馈表单](https://forms.api.com/feedback)与我们分享。 +