整理 [二、使用说明] [三、接口文档] 部分文档

docs/manual/api/backend-interface.md

@@ -0,0 +1 @@
+.keep

docs/manual/api/frontend-interface/0. 概述/通用参数（待完成）.md

@@ -0,0 +1 @@
+.keep

docs/manual/api/frontend-interface/用户类 - 修改账户信息.md

@@ -0,0 +1,131 @@
+> **密码禁止明文传输！** 加密方法见：开发文档 > 规范 > 注册、登录时密码使用的加密技术
+
+## 接口列表
+
+> api基础路径为 `./api/v1/users`
+
+<!-- ##################################  ################################## -->
+### ● 修改昵称
+
+通过此接口实现用户昵称修改功能。
+
+> 更新日期：2021.02.27
+> **info** 所有版本均支持此接口
+> 使用此接口前，须先进行用户登录
+
+**接口地址**：./api/v1/users/modify_user_nickname.php
+**请求方式**：POST
+
+<details>
+<summary>接口详细信息（点击展开）</summary>
+
+| 参数名称     | 是否必须 | 类型   | 参数值示例   | 说明     |
+| :---------- | :------: | :----- | :----- | :------- |
+| key         |    是    | string | ajax | 固定参数，填写`"ajax"` |
+| nickname    |    是    | string | 111111 | 用户修改后的新用户名（放在URL参数中） |
+| uuid        |    是    | string |  | 用户uuid |
+
+#### 请求示例：
+
+```javascript
+// jQuery
+$.ajax({
+	type: "post",
+	url: "./api/v1/users/modify_user_nickname.php?nickname=" + newNickname,
+	data: {key: 'ajax', uuid: '用户uuid'},
+	dataType: "json",
+	success: function (res) {
+		if(res){
+			if(res.success == true)
+				 /* 昵称修改成功 */
+			else
+				/* 昵称修改失败 */
+		}
+	},
+	error:function (res) {
+		// 请求失败回调函数
+	}
+});
+```
+
+**返回格式**：`json`
+
+| 返回参数     | 类型   | 参数值示例   | 说明     |
+| :---------- | :----- | :----- | :------- |
+| msg         | string | 这是一条消息 | 修改成功/失败时的提示消息 |
+| success     | bool   | true | 用于判断用户昵称是否修改成功 |
+
+#### 返回示例：
+
+```javascript
+{"msg":"信息","success":true}
+```
+</details>
+
+<!-- ##################################  ################################## -->
+--------------------------------------------------------------------------------
+
+### ● 修改密码
+
+通过此接口实现用户密码修改功能。
+
+> 更新日期：2021.02.27
+> **info** 所有版本均支持此接口
+> 使用此接口前，须先进行用户登录
+
+**接口地址**：./api/v1/users/modify_user_nickname.php
+**请求方式**：POST
+
+<details>
+<summary>接口详细信息（点击展开）</summary>
+
+| 参数名称     | 是否必须 | 类型   | 参数值示例   | 说明     |
+| :---------- | :------: | :----- | :----- | :------- |
+| key         |    是    | string | ajax | 固定参数，填写`"ajax"` |
+| uuid        |    是    | string |  | 用户uuid |
+| oldPwd      |    是    | string |  | 旧密码（加密后） |
+| newPwd      |    是    | string |  | 新密码（加密后） |
+| newPwd_Confirm |    是    | string |  | 新密码确认（加密后） |
+
+#### 请求示例：
+
+```javascript
+// jQuery
+$.ajax({
+    type: "post",
+    url: "./api/v1/users/modify_user_password.php",
+    data: {
+        key: 'ajax',
+        uuid: '用户uuid',
+        oldPwd: Base64.encode(Base64.encode(oldPwd.split('').reverse().join('')).split('').reverse().join('')),
+        newPwd: Base64.encode(Base64.encode(newPwd.split('').reverse().join('')).split('').reverse().join('')),
+        newPwd_Confirm: Base64.encode(Base64.encode(newPwd_Confirm.split('').reverse().join('')).split('').reverse().join('')),
+    },
+    dataType: "json",
+    success: function (res) {
+        if(res){
+            if(res.success == true)
+                /* 密码修改成功 */
+            else
+                /* 密码修改失败 */
+        }
+    },
+    error:function (res) {
+        // 请求失败回调函数
+    }
+});
+```
+
+**返回格式**：`json`
+
+| 返回参数     | 类型   | 参数值示例   | 说明     |
+| :---------- | :----- | :----- | :------- |
+| msg          | string | 这是一条消息 | 修改成功/失败时的提示消息 |
+| success     | bool   | true | 用于判断用户密码是否修改成功 |
+
+#### 返回示例：
+
+```javascript
+{"msg":"信息","success":true}
+```
+</details>

docs/manual/api/frontend-interface/用户类 - 用户登录、注销、获取状态.md

@@ -0,0 +1,163 @@
+> **密码禁止明文传输！** 加密方法见：开发文档 > 规范 > 注册、登录时密码使用的加密技术
+
+## 接口列表
+
+> api基础路径为 `./api/v1/users`
+
+<!-- ##################################  ################################## -->
+### ● 用户登录
+
+通过此接口实现用户登录功能。
+
+> 更新日期：2021.02.27
+> **info** 所有版本均支持此接口
+
+**接口地址**：./api/v1/users/login.php
+**请求方式**：POST
+
+<details>
+<summary>接口详细信息（点击展开）</summary>
+
+| 参数名称     | 是否必须 | 类型   | 参数值示例   | 说明     |
+| :---------- | :------: | :----- | :----- | :------- |
+| username    |    是    | string | 111111 | 用户名 |
+| password    |    是    | string | c97ee47294955604c0af78f83b3c735a | 密码（需要加密） |
+| captcha     |    是    | string | 7438 | 用户输入的验证码 |
+| login_token |    是    | string | 9f8f89ac0de94f7578e96dd9129bfc5a | 发回页面加载时生成的令牌 |
+
+#### 请求示例：
+
+```javascript
+// jQuery
+$.ajax({
+    type: "POST", 
+    url: 'api/v1/users/login.php',
+    dataType: "json",
+    data: {
+        username: "",     // 用户名
+        password: "",     // 密码
+        captcha: "",      // 验证码
+        login_token: "",  // 登录token
+    },
+    success: function (res) {
+        if(res){
+            if(res.success == true) {
+                // 登录成功
+            } else {
+                // 登录失败
+            }
+        }
+    },
+    error:function (res) { 
+        // POST失败时回调函数
+    } 
+});
+```
+
+**返回格式**：`json`
+
+| 返回参数     | 类型   | 参数值示例   | 说明     |
+| :---------- | :----- | :----- | :------- |
+| flag        | string |  | 状态码 |
+| message     | string | 这是一条消息 | 登录成功/失败时的提示消息 |
+| success     | bool   | true | 用于判断用户是否登陆成功 |
+| action      | array  | ["refresh_Page"] | 用于指示前端应该执行何种操作，例如清空文本框，刷新页面等等 |
+
+#### 返回示例：
+
+```javascript
+{
+    "flag":"状态码",
+    "message":"登录成功/失败提示信息",
+    "success":true,  // 用于指示是否登录成功
+    "action":["前台事件1","前台事件2", ... ]
+}
+```
+</details>
+
+<!-- ##################################  ################################## -->
+--------------------------------------------------------------------------------
+
+### ● 获取用户登录状态
+
+通过此接口获取用户登录是否登录。如果登陆成功，可以获得用户名和用户昵称。
+
+> 更新日期：2021.02.27
+> **info** 所有版本均支持此接口
+
+**接口地址**：./api/v1/users/get-status.php
+**请求方式**：GET
+
+<details>
+<summary>接口详细信息（点击展开）</summary>
+
+#### 请求示例：
+
+```javascript
+// jQuery
+$.getJSON("api/v1/users/get-status.php",function (res) {
+    if(res['flag']){
+        // 已经登录
+    }else{
+        // 没有登录
+    }
+});
+```
+
+**返回格式**：`json`
+
+| 返回参数     | 类型   | 参数值示例   | 说明     |
+| :---------- | :----- | :----- | :------- |
+| username    | string | 111111 | 用户名（仅用户登录状态下返回） |
+| nickname    | string | 用户昵称 | 用户昵称（仅用户登录状态下返回） |
+| flag        | bool   | true | 是否登录 |
+
+#### 返回示例：
+
+```javascript
+/* 已登录 */
+{"username":"用户名","nickname":"用户昵称","flag":true}
+
+/* 未登录 */
+{"flag":false}
+```
+</details>
+
+<!-- ##################################  ################################## -->
+--------------------------------------------------------------------------------
+
+### ● 退出登录
+
+通过此接口让用户退出。
+
+> 更新日期：2021.02.27
+> **info** 所有版本均支持此接口
+
+**接口地址**：./api/v1/users/logout.php
+**请求方式**：GET
+
+<details>
+<summary>接口详细信息（点击展开）</summary>
+
+#### 请求示例：
+
+```javascript
+// jQuery
+$.getJSON("api/v1/users/logout.php",function (res) {
+    if(res){
+        // 退出登录成功，可以执行页面跳转
+    }else{
+        // 退出登录失败
+    }
+});
+```
+
+**返回格式**：`json`
+
+#### 返回示例：
+
+```javascript
+{true}
+```
+</details>
+

docs/manual/api/interface-template.md

@@ -0,0 +1,86 @@
+# 前端接口文档模板
+
+ <!-- ################## 模板 开始 ################## -->
+
+#### 【XXX】
+
+这里填写接口简介。
+
+> 更新日期：2021.XX.XX
+> _**i**_ 支持v1.0.X及以上版本，低版本需做兼容处理。
+> 或
+> **** 所有版本均支持此接口
+
+> 使用此接口前，须先进行用户登录
+> 或
+> 此接口无需用户登录
+
+**接口地址**：./api/v1/user/insert
+**请求方式**：POST / GET
+
+<details>
+<summary>接口详细信息（点击展开）</summary>
+
+
+| 参数名称     | 是否必须 | 类型   | 参数值示例   | 说明     |
+| :---------- | :------: | :----- | :----- | :------- |
+| name        |    是    | string | 张三 | 姓名     |
+| age         |    是    | int    | 18 | 年龄     |
+| city        |    是    | string | 湖北省武汉市 | 城市     |
+| address     |    是    | string | 湖北省武汉市武昌区友谊大道368号 | 详细地址 |
+| email       |    是    | string | xxx@xx.com | 邮箱地址 |
+| phone       |    是    | string | 18900000000 | 手机号码 |
+| weixin      |    是    | string | xxxxxxx | 微信号码 |
+| qq          |    是    | string | 1234567890 | qq号码   |
+| weibo       |    是    | string | https://www.weibo.com/xxxxxx | 微博地址 |
+| description |    是    | string | 此人很懒，没有填写简介 | 个人简介 |
+| description |    否    | string | 此人很懒，没有填写简介 | 非必须时，可以在这里说明默认值 |
+
+
+| 参数名称      | 是否必须 | 值   | 说明     |
+| :----------- | :------: | :----- | :------- |
+| Content-Type |    是    | application/json |      |
+| Content-Type |    是    | application/x-www-form-urlencoded |      |
+
+#### 请求示例：
+
+```javascript
+xxxxxx
+```
+
+**返回格式**：`json`
+
+| 返回参数     | 类型   | 参数值示例   | 说明     |
+| :---------- | :----- | :----- | :------- |
+| status      | string | 0 | 状态码，0表示正常，-1表示错 |
+| msg         | string | 这是一条消息 | 返回的消息 |
+| data        | string | 这是一个data | 本次新增的用户编号，用于新增其他信息的userid参数 |
+
+#### 返回示例：
+
+```javascript
+/* 成功 */
+{
+  status:0,
+  msg:"用户新增成功",
+  data:1
+}
+
+/* 失败 */
+{
+  status:1,
+  msg:"用户新增失败"
+}
+```
+
+</details>
+
+<!-- ################## 模板 结束 ################## -->
+
+----------
+
+# 后端接口文档模板
+
+ <!-- ################## 模板 开始 ################## -->
+
+<!-- ################## 模板 结束 ################## -->

docs/manual/api/introduction.md

@@ -0,0 +1,13 @@
+为了应对各种各样的扩展需求，先提供统一接口供开发者使用。
+
+接口分为`前端接口`和`后端接口`，
+浏览器中运行的JavaScript脚本可以通过`前端接口`与服务器进行交流，
+开发应用/插件时，PHP文件内可以使用`后端接口`获取或设置相关数据。
+
+除公开数据外，涉及到用户相关操作`前端接口`均需要提供相关参数以验证用户是否登录，避免`前端接口`被滥用。
+
+接口分为以下几类：
+- 公开类，包括前台文章，浏览量，点赞量等无需用户登录即可调用
+- 数据写入类，表单提交调用，例如评论，点赞等
+- 用户账户类，用户登录状态下，对账户信息进行管理（读取、填写、修改、删除等）
+- 管理员类，仅管理员可使用，包括网站全局配置（后台的一系列配置），例如网站标题，第三方统计，服务器环境查看（phpinfo）等。

docs/manual/api/status-code.md

@@ -0,0 +1,82 @@
+# 权限相关 
+> 版本：v1.0.0
+更新日期：2021.01.19
+前缀：000××
+
+| 状态码 | 内容 | 提示消息 | 备注 |
+| --- | --- | --- | --- |
+| 00001 | 权限不足 | 权限不足 | 还未启用 |
+
+
+# 登录相关
+> 版本：v1.0.3
+更新日期：2021.01.21
+前缀：100××
+
+| 状态码 | 内容 | 提示消息 | 备注 |
+| --- | --- | --- | --- |
+| 10000 | 登录成功 | 登录成功 |  |
+| 10010 | 验证码输入错误 | 验证码输入错误，请重试 |  |
+| 10011 | 验证码已经失效 | 验证码已经失效，请重试 |  |
+| 10012 | 验证码未输入 | 验证码未输入 |  |
+| 10020 | 用户名或密码错误 | 用户名或密码错误 | 用户存在 |
+| 10021 | 用户名未输入 | 用户名未输入 |  |
+| 10022 | 密码未输入 | 密码未输入 |  |
+| 10023 | 用户不存在 | 用户不存在 |  |
+| 10030 | 已登录帐号，但未确定是否为当前帐号 | 您已登录 |  |
+| 10031 | 已登录当前帐号 | 您已登录当前帐号，无需再次登录 | 基于安全性考虑，目前返回状态码更改为10030 |
+| 10032 | 已登录其他帐号 | 当前登录帐号与您正在登录的账号不同，请先注销后再登录 | 基于安全性考虑，目前返回状态码更改为10030 |
+| 10040 | 系统未知错误 | 系统未知错误 |  |
+| 10041 | 服务器原因登录失败 | 服务器原因登录失败 |  |
+| 10050 | 无效token | 页面过期啦，请刷新再试 |  |
+| 10051 | 无token | 页面过期啦，请刷新再试 |  |
+
+
+# 注册相关
+> 版本：v1.0.3
+更新日期：2021.01.20
+前缀：200××
+
+| 状态码 | 内容 | 提示消息 | 备注 |
+| --- | --- | --- | --- |
+| 20000 | 注册成功 | 注册成功 |  |
+| 20010 | 验证码输入错误 | 验证码输入错误，请重试 |  |
+| 20011 | 验证码已经失效 | 验证码已经失效，请重试 |  |
+| 20012 | 验证码未输入 | 验证码未输入 |  |
+| 20020 | 用户名已存在 | 用户名已存在 |  |
+| 20021 | 用户名未输入 | 用户名未输入 |  |
+| 20022 | 密码未输入 | 密码未输入 |  |
+| 20023 | 确认密码未输入 | 确认密码未输入 |  |
+| 20024 | 两次密码不相同 | 两次密码不相同 |  |
+| 20025 | 昵称未输入 | 昵称未输入 |  |
+| 20026 | 用户名太短、太长或含有特殊字符、中文 | 用户名太短、太长或含有特殊字符、中文 |  |
+| 20027 | 昵称太短、太长或含有特殊字符 | 昵称太短、太长或含有特殊字符 | 还未启用 |
+| 20028 | 密码太短、太长或含有特殊字符、中文 | 密码太短、太长或含有特殊字符、中文 |  |
+| 20032 | 已登录其他帐号 | 已登录其他帐号，请退出后再注册 |  |
+| 20040 | 系统未知错误 | 系统未知错误 |  |
+| 20041 | 服务器原因注册失败 | 服务器原因注册失败 |  |
+| 20050 | 无效token | 页面过期啦，请刷新再试 |  |
+| 20051 | 无token | 页面过期啦，请刷新再试 |  |
+
+
+# 文件上传相关
+> 版本：v1.0.2
+更新日期：2021.01.28
+前缀：300××
+
+| 状态码 | 内容 | 提示消息 | 备注 |
+| --- | --- | --- | --- |
+| 30000 | 上传成功 | 上传成功 |  |
+| 30010 | 验证码输入错误 | 验证码输入错误，请重试 | 还未启用 |
+| 30011 | 验证码已经失效 | 验证码已经失效，请重试 | 还未启用 |
+| 30012 | 验证码未输入 | 验证码未输入 | 还未启用 |
+| 30013 | 未登录账号 | 用户未登录，请登录后再上传 |  |
+| 30020 | 文件格式不支持 | 文件格式不支持 |  |
+| 30021 | 文件太大 | 文件太大了，请尝试将文件分多次上传 |  |
+| 30022 | 空文件 | 上传失败，文件为空 |  |
+| 30030 | 文件读取失败 | 文件读取失败，请确认文件可以正常打开后重新上传 | 还未启用 |
+| 30031 | 文件上传时php系统报错 | 文件上传出错啦 | 同时输出详细错误信息（message_detail） |
+| 30040 | 系统未知错误 | 系统未知错误 |  |
+| 30041 | 服务器原因上传失败 | 服务器原因上传失败 | 还未启用（文件已经存在暂时使用，后期要调整） |
+| 30050 | 无效token | 页面过期啦，请刷新再试 |  |
+| 30051 | 无token | 页面过期啦，请刷新再试 |  |