From 017a2df499e4f146fa1e720fe9806551418bc5ef Mon Sep 17 00:00:00 2001
From: whz <303054730@qq.com>
Date: Tue, 30 Apr 2024 08:22:45 +0800
Subject: [PATCH] [add]docs

---
 .gitignore              |  1 +
 docs/API接口说明模板.md | 86 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 87 insertions(+)
 create mode 100644 docs/API接口说明模板.md

diff --git a/.gitignore b/.gitignore
index 9154f4c..87271a8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -24,3 +24,4 @@
 hs_err_pid*
 replay_pid*
 
+.idea
\ No newline at end of file
diff --git a/docs/API接口说明模板.md b/docs/API接口说明模板.md
new file mode 100644
index 0000000..c54e265
--- /dev/null
+++ b/docs/API接口说明模板.md
@@ -0,0 +1,86 @@
+# RESTFul API 文档 v1.0
+
+## 1. 用户注册
+
+### 1.1 接口描述
+本API允许用户通过手机号或邮箱地址创建新账户。确保每个手机号或邮箱仅关联一个唯一账户。
+
+### 1.2 请求URL
+`/api/user/signup`
+
+### 1.3 请求方式
+**POST**
+
+### 1.4 请求头
+| 头字段       | 必填 | 数据类型      | 描述                           |
+| ------------ | ---- | ------------- | -------------------------------- |
+| Content-Type | 是   | application/json | 指定请求体的媒体类型为JSON |
+
+### 1.5 请求体参数
+| 参数名称      | 必填 | 数据类型 | 约束条件 | 描述                        | 示例         | 允许空值 |
+|-----------| ---- | -------- | -------- | ---------------------------- | ------------ | -------- |
+| account   | 是   | 字符串   | 1-50字符 | 用于登录的账号（手机号或邮箱） | "user123"    | 否       |
+| password  | 是   | 字符串   | 1-50字符 | 密码     | "p@ssw0rd"   | 否       |
+| checkCode | 是   | 字符串   | 6位数字  | 注册时收到的验证码          | "123456"     | 否       |
+
+### 1.6 请求示例
+```http
+POST /api/user/signup
+Host: {apiAddress}
+Content-Type: application/json
+
+{
+"account": "user123",
+"password": "p@ssw0rd",
+"checkCode": "123456"
+}
+```
+
+### 1.7 返回参数说明
+| 参数名称      | 必填 | 数据类型 | 约束条件 | 描述                        |
+|-----------| ---- | -------- | -------- | ---------------------------- |
+| code  | 是   | 整型   | | 错误码，200表示成功 |
+| message | 否   | 字符串   | 1-50字符 | 错误信息描述     |
+| data | 否  | json  |   | 具体业务数据          |
+
+
+### 1.8 响应示例（成功）
+
+```json
+ {
+  "code": 200,
+  "message": "注册成功",
+  "data": {
+    "id": "123456",
+    "account": "user123"
+  }
+}
+```
+### 1.9 响应示例（错误）
+```json
+{ "code": 10001, "message": "验证码无效" }
+```
+
+### 1.10 错误响应码参考
+更多响应错误码及含义，请参阅[API响应码表](URL/for/api/responseCode/table)。
+
+### 1.11 安全性与认证
+此API要求调用方在`Authorization`头中携带经过Bearer认证的令牌。
+
+### 1.12 测试环境
+访问测试环境以进行接口调试：
+[https://test.apiAddress.com](https://test.apiAddress.com)
+
+### 1.13 版本管理
+本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。
+
+### 1.14 更新记录
+- **2024-04-22**：发布文档初始版本。
+- **2024-05-05**：新增安全性说明和测试环境链接。
+
+### 1.15 联系支持
+如需帮助或对API有任何疑问，请通过电子邮件与我们联系：[support@api.com](mailto:support@api.com)。
+
+### 1.16 反馈与建议
+发现文档问题或有改进建议？请填写[反馈表单](https://forms.api.com/feedback)与我们分享。
+