87 lines
2.7 KiB
Markdown
87 lines
2.7 KiB
Markdown
# RESTFul API 文档 v0
|
||
|
||
## 用户注册
|
||
|
||
### 1 接口描述
|
||
本API允许用户通过手机号或邮箱地址创建新账户。确保每个手机号或邮箱仅关联一个唯一账户。
|
||
|
||
### 2 请求URL
|
||
`/api/user/signup`
|
||
|
||
### 3 请求方式
|
||
**POST**
|
||
|
||
### 4 请求头
|
||
| 头字段 | 必填 | 数据类型 | 描述 |
|
||
| ------------ | ---- | ------------- | -------------------------------- |
|
||
| Content-Type | 是 | application/json | 指定请求体的媒体类型为JSON |
|
||
|
||
### 5 请求体参数
|
||
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 | 示例 | 允许空值 |
|
||
|-----------| ---- | -------- | -------- | ---------------------------- | ------------ | -------- |
|
||
| account | 是 | 字符串 | 1-50字符 | 用于登录的账号（手机号或邮箱） | "user123" | 否 |
|
||
| password | 是 | 字符串 | 1-50字符 | 密码 | "p@ssw0rd" | 否 |
|
||
| checkCode | 是 | 字符串 | 6位数字 | 注册时收到的验证码 | "123456" | 否 |
|
||
|
||
### 6 请求示例
|
||
```http
|
||
POST /api/user/signup
|
||
Host: {apiAddress}
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"account": "user123",
|
||
"password": "p@ssw0rd",
|
||
"checkCode": "123456"
|
||
}
|
||
```
|
||
|
||
### 7 返回参数说明
|
||
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 |
|
||
|------| ---- | -------- | -------- | ---------------------------- |
|
||
| code | 是 | 整型 | | 错误码，200表示成功 |
|
||
| msg | 否 | 字符串 | 1-50字符 | 错误信息描述 |
|
||
| data | 否 | json | | 具体业务数据 |
|
||
|
||
|
||
### 8 响应示例（成功）
|
||
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"message": "注册成功",
|
||
"data": {
|
||
"id": "123456",
|
||
"account": "user123"
|
||
}
|
||
}
|
||
```
|
||
### 9 响应示例（错误）
|
||
```json
|
||
{ "code": 10001, "message": "验证码无效" }
|
||
```
|
||
|
||
### 10 错误响应码参考
|
||
更多响应错误码及含义，请参阅[API响应码表](URL/for/api/responseCode/table)。
|
||
|
||
### 11 安全性与认证
|
||
此API要求调用方在`Authorization`头中携带经过Bearer认证的令牌。
|
||
|
||
### 12 测试环境
|
||
访问测试环境以进行接口调试：
|
||
[https://test.apiAddress.com](https://test.apiAddress.com)
|
||
|
||
### 13 版本管理
|
||
本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。
|
||
|
||
### 14 更新记录
|
||
- **2024-04-22**：发布文档初始版本。
|
||
- **2024-05-05**：新增安全性说明和测试环境链接。
|
||
|
||
### 15 联系支持
|
||
如需帮助或对API有任何疑问，请通过电子邮件与我们联系：[support@api.com](mailto:support@api.com)。
|
||
|
||
### 16 反馈与建议
|
||
发现文档问题或有改进建议？请填写[反馈表单](https://forms.api.com/feedback)与我们分享。
|
||
|