From 2cf1536add13d9fe5454ac2b9fcbed7024040c8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8C=81=E5=A3=AE=E6=88=90=E9=95=BF?= <2291200076@qq.com> Date: Sat, 7 Aug 2021 02:53:55 +0800 Subject: [PATCH] =?UTF-8?q?=E6=95=B4=E7=90=86=20[=E4=BA=8C=E3=80=81?= =?UTF-8?q?=E4=BD=BF=E7=94=A8=E8=AF=B4=E6=98=8E]=20[=E4=B8=89=E3=80=81?= =?UTF-8?q?=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3]=20=E9=83=A8=E5=88=86?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/_sidebar.md | 12 ++++++++++++ .../3. 前端Api接口（撰写中）/5. 词书/.keep | 0 .../3. 前端Api接口（撰写中）/6. 通知/.keep | 0 docs/manual/3. 接口文档/5. 文档模板/.keep | 0 docs/manual/4. 应用开发文档/.keep | 0 docs/manual/5. 关于/.keep | 0 docs/manual/6. 【清单 ToDo】/.keep | 0 .../manual/{2. 使用说明 => api/5. 文档模板}/.keep | 0 .../0. 概述/通用参数（待完成）.md => api/backend-interface.md} | 0 .../{3. 接口文档 => api/frontend-interface}/.keep | 0 .../frontend-interface/0. 概述/通用参数（待完成）.md} | 0 .../frontend-interface/1. 站点}/.keep | 0 .../frontend-interface}/1. 站点/上传logo（待完善）.md | 0 .../frontend-interface}/1. 站点/检查更新（待完善）.md | 0 .../frontend-interface}/1. 站点/站点基本信息（待完善）.md | 0 .../0. 概述 => api/frontend-interface/2. 管理员}/.keep | 0 .../frontend-interface}/2. 管理员/用户注册（待完善）.md | 0 .../frontend-interface}/2. 管理员/用户登录（待完善）.md | 0 .../frontend-interface}/2. 管理员/（待完善）.md | 0 .../1. 站点 => api/frontend-interface/3. 用户}/.keep | 0 .../frontend-interface}/3. 用户/用户注册（待完善）.md | 0 .../frontend-interface}/3. 用户/用户登录（待完善）.md | 0 .../frontend-interface}/3. 用户/（待完善）.md | 0 .../2. 管理员 => api/frontend-interface/4. 单词}/.keep | 0 .../3. 用户 => api/frontend-interface/5. 词书}/.keep | 0 .../4. 单词 => api/frontend-interface/6. 通知}/.keep | 0 .../frontend-interface}/用户类 - 修改账户信息.md | 0 .../frontend-interface}/用户类 - 用户登录、注销、获取状态.md | 0 .../前端Api接口.md => api/interface-template.md} | 15 +++++++++++++-- .../1. 简介.md => api/introduction.md} | 0 .../2. 全局状态码.md => api/status-code.md} | 0 .../start-using.md} | 0 docs/manual/start/.keep | 0 33 files changed, 25 insertions(+), 2 deletions(-) delete mode 100644 docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/5. 词书/.keep delete mode 100644 docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/6. 通知/.keep delete mode 100644 docs/manual/3. 接口文档/5. 文档模板/.keep delete mode 100644 docs/manual/4. 应用开发文档/.keep delete mode 100644 docs/manual/5. 关于/.keep delete mode 100644 docs/manual/6. 【清单 ToDo】/.keep rename docs/manual/{2. 使用说明 => api/5. 文档模板}/.keep (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/通用参数（待完成）.md => api/backend-interface.md} (100%) rename docs/manual/{3. 接口文档 => api/frontend-interface}/.keep (100%) rename docs/manual/{3. 接口文档/4. 后端Api接口（待完善）.md => api/frontend-interface/0. 概述/通用参数（待完成）.md} (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface/1. 站点}/.keep (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/1. 站点/上传logo（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/1. 站点/检查更新（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/1. 站点/站点基本信息（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中）/0. 概述 => api/frontend-interface/2. 管理员}/.keep (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/2. 管理员/用户注册（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/2. 管理员/用户登录（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/2. 管理员/（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中）/1. 站点 => api/frontend-interface/3. 用户}/.keep (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/3. 用户/用户注册（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/3. 用户/用户登录（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/3. 用户/（待完善）.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员 => api/frontend-interface/4. 单词}/.keep (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中）/3. 用户 => api/frontend-interface/5. 词书}/.keep (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中）/4. 单词 => api/frontend-interface/6. 通知}/.keep (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/用户类 - 修改账户信息.md (100%) rename docs/manual/{3. 接口文档/3. 前端Api接口（撰写中） => api/frontend-interface}/用户类 - 用户登录、注销、获取状态.md (100%) rename docs/manual/{3. 接口文档/5. 文档模板/前端Api接口.md => api/interface-template.md} (87%) rename docs/manual/{3. 接口文档/1. 简介.md => api/introduction.md} (100%) rename docs/manual/{3. 接口文档/2. 全局状态码.md => api/status-code.md} (100%) rename docs/manual/{2. 使用说明/开始使用（撰写中）.md => instructions/start-using.md} (100%) delete mode 100644 docs/manual/start/.keep diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 06b087b..6eea065 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -10,5 +10,17 @@ - [9. 目录结构（TODO）](manual/start/directory-structure) - [10. 常见问题](manual/start/faq) +- **二、使用说明** + - [1. 开始使用（撰写中）](manual/instructions/start-using) + +- **三、接口文档** + - [1. 简介](manual/api/introduction) + - [2. 全局状态码](manual/api/status-code) + - [【加sidebar!】3. 前端Api接口（撰写中）](manual/api/frontend-interface) + - [4. 后端Api接口（待完善）](manual/api/backend-interface) + - [5. 接口模板](manual/api/interface-template) + - [1. 简介](manual/api/introduction) + + - [TODO](manual/todo) - [test](manual/test) \ No newline at end of file diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/5. 词书/.keep b/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/5. 词书/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/6. 通知/.keep b/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/6. 通知/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/3. 接口文档/5. 文档模板/.keep b/docs/manual/3. 接口文档/5. 文档模板/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/4. 应用开发文档/.keep b/docs/manual/4. 应用开发文档/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/5. 关于/.keep b/docs/manual/5. 关于/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/6. 【清单 ToDo】/.keep b/docs/manual/6. 【清单 ToDo】/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/2. 使用说明/.keep b/docs/manual/api/5. 文档模板/.keep similarity index 100% rename from docs/manual/2. 使用说明/.keep rename to docs/manual/api/5. 文档模板/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/通用参数（待完成）.md b/docs/manual/api/backend-interface.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/通用参数（待完成）.md rename to docs/manual/api/backend-interface.md diff --git a/docs/manual/3. 接口文档/.keep b/docs/manual/api/frontend-interface/.keep similarity index 100% rename from docs/manual/3. 接口文档/.keep rename to docs/manual/api/frontend-interface/.keep diff --git a/docs/manual/3. 接口文档/4. 后端Api接口（待完善）.md b/docs/manual/api/frontend-interface/0. 概述/通用参数（待完成）.md similarity index 100% rename from docs/manual/3. 接口文档/4. 后端Api接口（待完善）.md rename to docs/manual/api/frontend-interface/0. 概述/通用参数（待完成）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/.keep b/docs/manual/api/frontend-interface/1. 站点/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/.keep rename to docs/manual/api/frontend-interface/1. 站点/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/上传logo（待完善）.md b/docs/manual/api/frontend-interface/1. 站点/上传logo（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/上传logo（待完善）.md rename to docs/manual/api/frontend-interface/1. 站点/上传logo（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/检查更新（待完善）.md b/docs/manual/api/frontend-interface/1. 站点/检查更新（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/检查更新（待完善）.md rename to docs/manual/api/frontend-interface/1. 站点/检查更新（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/站点基本信息（待完善）.md b/docs/manual/api/frontend-interface/1. 站点/站点基本信息（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/站点基本信息（待完善）.md rename to docs/manual/api/frontend-interface/1. 站点/站点基本信息（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/.keep b/docs/manual/api/frontend-interface/2. 管理员/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/.keep rename to docs/manual/api/frontend-interface/2. 管理员/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户注册（待完善）.md b/docs/manual/api/frontend-interface/2. 管理员/用户注册（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户注册（待完善）.md rename to docs/manual/api/frontend-interface/2. 管理员/用户注册（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户登录（待完善）.md b/docs/manual/api/frontend-interface/2. 管理员/用户登录（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户登录（待完善）.md rename to docs/manual/api/frontend-interface/2. 管理员/用户登录（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/（待完善）.md b/docs/manual/api/frontend-interface/2. 管理员/（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/（待完善）.md rename to docs/manual/api/frontend-interface/2. 管理员/（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/.keep b/docs/manual/api/frontend-interface/3. 用户/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/.keep rename to docs/manual/api/frontend-interface/3. 用户/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户注册（待完善）.md b/docs/manual/api/frontend-interface/3. 用户/用户注册（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户注册（待完善）.md rename to docs/manual/api/frontend-interface/3. 用户/用户注册（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户登录（待完善）.md b/docs/manual/api/frontend-interface/3. 用户/用户登录（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户登录（待完善）.md rename to docs/manual/api/frontend-interface/3. 用户/用户登录（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/（待完善）.md b/docs/manual/api/frontend-interface/3. 用户/（待完善）.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/（待完善）.md rename to docs/manual/api/frontend-interface/3. 用户/（待完善）.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/.keep b/docs/manual/api/frontend-interface/4. 单词/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/.keep rename to docs/manual/api/frontend-interface/4. 单词/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/.keep b/docs/manual/api/frontend-interface/5. 词书/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/.keep rename to docs/manual/api/frontend-interface/5. 词书/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/4. 单词/.keep b/docs/manual/api/frontend-interface/6. 通知/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/4. 单词/.keep rename to docs/manual/api/frontend-interface/6. 通知/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 修改账户信息.md b/docs/manual/api/frontend-interface/用户类 - 修改账户信息.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 修改账户信息.md rename to docs/manual/api/frontend-interface/用户类 - 修改账户信息.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 用户登录、注销、获取状态.md b/docs/manual/api/frontend-interface/用户类 - 用户登录、注销、获取状态.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 用户登录、注销、获取状态.md rename to docs/manual/api/frontend-interface/用户类 - 用户登录、注销、获取状态.md diff --git a/docs/manual/3. 接口文档/5. 文档模板/前端Api接口.md b/docs/manual/api/interface-template.md similarity index 87% rename from docs/manual/3. 接口文档/5. 文档模板/前端Api接口.md rename to docs/manual/api/interface-template.md index 2d87f34..afa1fb8 100644 --- a/docs/manual/3. 接口文档/5. 文档模板/前端Api接口.md +++ b/docs/manual/api/interface-template.md @@ -1,4 +1,7 @@ - +# 前端接口文档模板 + + + #### 【XXX】 这里填写接口简介。 @@ -72,4 +75,12 @@ xxxxxx - \ No newline at end of file + + +---------- + +# 后端接口文档模板 + + + + diff --git a/docs/manual/3. 接口文档/1. 简介.md b/docs/manual/api/introduction.md similarity index 100% rename from docs/manual/3. 接口文档/1. 简介.md rename to docs/manual/api/introduction.md diff --git a/docs/manual/3. 接口文档/2. 全局状态码.md b/docs/manual/api/status-code.md similarity index 100% rename from docs/manual/3. 接口文档/2. 全局状态码.md rename to docs/manual/api/status-code.md diff --git a/docs/manual/2. 使用说明/开始使用（撰写中）.md b/docs/manual/instructions/start-using.md similarity index 100% rename from docs/manual/2. 使用说明/开始使用（撰写中）.md rename to docs/manual/instructions/start-using.md diff --git a/docs/manual/start/.keep b/docs/manual/start/.keep deleted file mode 100644 index e69de29..0000000