mirror of
https://gitee.com/tawords/tawords-docs
synced 2025-09-02 16:03:27 +08:00
网站使用相对路径;整理 [三、接口文档] 部分文档
This commit is contained in:
@@ -1 +0,0 @@
|
||||
.keep
|
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
12
docs/manual/api/frontend-interface/Admin.md
Normal file
12
docs/manual/api/frontend-interface/Admin.md
Normal file
@@ -0,0 +1,12 @@
|
||||
## 用户登录
|
||||
|
||||
<!-- 引入“Admin--login-status.md” -->
|
||||
[用户登录](Admin--login-status.md ':include')
|
||||
|
||||
-----
|
||||
|
||||
## 用户注册
|
||||
|
||||
<!-- 引入“Admin--account-registration.md” -->
|
||||
[用户注册](Admin--account-registration.md ':include')
|
||||
|
@@ -0,0 +1,2 @@
|
||||
### (待完成)
|
||||
|
5
docs/manual/api/frontend-interface/General.md
Normal file
5
docs/manual/api/frontend-interface/General.md
Normal file
@@ -0,0 +1,5 @@
|
||||
## 通用参数
|
||||
|
||||
<!-- 引入“General--parameters.md” -->
|
||||
[通用参数](General--parameters.md ':include')
|
||||
|
2
docs/manual/api/frontend-interface/Notice--xxx.md
Normal file
2
docs/manual/api/frontend-interface/Notice--xxx.md
Normal file
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
5
docs/manual/api/frontend-interface/Notice.md
Normal file
5
docs/manual/api/frontend-interface/Notice.md
Normal file
@@ -0,0 +1,5 @@
|
||||
## xxx
|
||||
|
||||
<!-- 引入“xxx” -->
|
||||
[xxx](Notice--xxx.md ':include')
|
||||
|
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
2
docs/manual/api/frontend-interface/Site--check-update.md
Normal file
2
docs/manual/api/frontend-interface/Site--check-update.md
Normal file
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
2
docs/manual/api/frontend-interface/Site--upload-logo.md
Normal file
2
docs/manual/api/frontend-interface/Site--upload-logo.md
Normal file
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
19
docs/manual/api/frontend-interface/Site.md
Normal file
19
docs/manual/api/frontend-interface/Site.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## 检查更新
|
||||
|
||||
<!-- 引入“Site--check-update.md” -->
|
||||
[检查更新](Site--check-update.md ':include')
|
||||
|
||||
-----
|
||||
|
||||
## 上传logo
|
||||
|
||||
<!-- 引入“Site--upload-logo.md” -->
|
||||
[上传logo](Site--upload-logo.md ':include')
|
||||
|
||||
-----
|
||||
|
||||
## 站点基本信息
|
||||
|
||||
<!-- 引入“Site--basic-Information.md” -->
|
||||
[站点基本信息](Site--basic-Information.md ':include')
|
||||
|
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
@@ -1,7 +1,5 @@
|
||||
> **密码禁止明文传输!** 加密方法见:开发文档 > 规范 > 注册、登录时密码使用的加密技术
|
||||
|
||||
## 接口列表
|
||||
|
||||
> api基础路径为 `./api/v1/users`
|
||||
|
||||
<!-- ################################## ################################## -->
|
||||
@@ -76,6 +74,7 @@ $.ajax({
|
||||
</details>
|
||||
|
||||
<!-- ################################## ################################## -->
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
### ● 获取用户登录状态
|
||||
@@ -124,6 +123,7 @@ $.getJSON("api/v1/users/get-status.php",function (res) {
|
||||
</details>
|
||||
|
||||
<!-- ################################## ################################## -->
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
### ● 退出登录
|
@@ -1,7 +1,5 @@
|
||||
> **密码禁止明文传输!** 加密方法见:开发文档 > 规范 > 注册、登录时密码使用的加密技术
|
||||
|
||||
## 接口列表
|
||||
|
||||
> api基础路径为 `./api/v1/users`
|
||||
|
||||
<!-- ################################## ################################## -->
|
||||
@@ -63,6 +61,7 @@ $.ajax({
|
||||
</details>
|
||||
|
||||
<!-- ################################## ################################## -->
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
### ● 修改密码
|
19
docs/manual/api/frontend-interface/User.md
Normal file
19
docs/manual/api/frontend-interface/User.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## 修改账户信息
|
||||
|
||||
<!-- 引入“User--modify-account-information.md” -->
|
||||
[修改账户信息](User--modify-account-information.md ':include')
|
||||
|
||||
-----
|
||||
|
||||
## 用户登录、注销、获取状态
|
||||
|
||||
<!-- 引入“User--login-status.md” -->
|
||||
[用户登录、注销、获取状态](User--login-status.md ':include')
|
||||
|
||||
-----
|
||||
|
||||
## 用户注册
|
||||
|
||||
<!-- 引入“User--account-registration.md” -->
|
||||
[用户注册](User--account-registration.md ':include')
|
||||
|
2
docs/manual/api/frontend-interface/Wordbooks--xxx.md
Normal file
2
docs/manual/api/frontend-interface/Wordbooks--xxx.md
Normal file
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
5
docs/manual/api/frontend-interface/Wordbooks.md
Normal file
5
docs/manual/api/frontend-interface/Wordbooks.md
Normal file
@@ -0,0 +1,5 @@
|
||||
## xxx
|
||||
|
||||
<!-- 引入“xxx” -->
|
||||
[xxx](Wordbooks--xxx.md ':include')
|
||||
|
2
docs/manual/api/frontend-interface/Words--xxx.md
Normal file
2
docs/manual/api/frontend-interface/Words--xxx.md
Normal file
@@ -0,0 +1,2 @@
|
||||
### (待完善)
|
||||
|
5
docs/manual/api/frontend-interface/Words.md
Normal file
5
docs/manual/api/frontend-interface/Words.md
Normal file
@@ -0,0 +1,5 @@
|
||||
## xxx
|
||||
|
||||
<!-- 引入“xxx” -->
|
||||
[xxx](Words--xxx.md ':include')
|
||||
|
7
docs/manual/api/frontend-interface/overview.md
Normal file
7
docs/manual/api/frontend-interface/overview.md
Normal file
@@ -0,0 +1,7 @@
|
||||
- [0. 通用参数](./General)
|
||||
- [1. 站点](./Site)
|
||||
- [2. 管理员](./Admin)
|
||||
- [3. 用户](./User)
|
||||
- [4. 单词](./Words)
|
||||
- [5. 词书](./Wordbooks)
|
||||
- [6. 通知](./Notice)
|
Reference in New Issue
Block a user