From 3497772ea7adb16811f551762941dda6c4f3ab59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A8=8B=E5=BA=8F=E5=91=98=E5=B0=8F=E5=A2=A8?= <2291200076@qq.com> Date: Mon, 4 Apr 2022 10:31:00 +0800 Subject: [PATCH] update api-docs --- bookshelfplus-frontend/public/package.json | 18 - .../docs/asciidoc/generated/all.adoc | 415 +++- bookshelfplus/docs/asciidoc/html/all.html | 1729 +++++++++++++---- 3 files changed, 1757 insertions(+), 405 deletions(-) delete mode 100644 bookshelfplus-frontend/public/package.json diff --git a/bookshelfplus-frontend/public/package.json b/bookshelfplus-frontend/public/package.json deleted file mode 100644 index caf457c..0000000 --- a/bookshelfplus-frontend/public/package.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "bookshelf-plus", - "version": "1.0.0", - "description": "书栖网", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "repository": { - "type": "git", - "url": "https://gitee.com/only4/bookshelf.git" - }, - "keywords": [ - "书栖网" - ], - "author": "Coding Zhang", - "license": "MIT" -} diff --git a/bookshelfplus/docs/asciidoc/generated/all.adoc b/bookshelfplus/docs/asciidoc/generated/all.adoc index e25084e..15640e9 100644 --- a/bookshelfplus/docs/asciidoc/generated/all.adoc +++ b/bookshelfplus/docs/asciidoc/generated/all.adoc @@ -21,6 +21,8 @@ __域名__ : localhost:8090 * 书籍信息 : Book Controller * 书籍分类信息 : Category Controller * 用户操作 : User Controller +* 第三方登录 : Third Party Controller +* 系统调试接口 : Debug Controller * 网站后台状态检测 : Status Controller @@ -34,6 +36,82 @@ __域名__ : localhost:8090 Book Controller +[[_addusingget]] +==== 【管理员】添加书籍 +.... +GET /api/book/add +.... + + +===== 说明 +管理员在后台添加书籍 + + +===== 参数 + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|类型|名称|说明|类型 +|**Query**|**author** + +__可选__|author|string +|**Query**|**bookName** + +__可选__|bookName|string +|**Query**|**categoryId** + +__可选__|categoryId|integer (int32) +|**Query**|**copyright** + +__可选__|copyright|string +|**Query**|**description** + +__可选__|description|string +|**Query**|**isDelete** + +__可选__|isDelete|boolean +|**Query**|**language** + +__可选__|language|string +|**Query**|**publishingHouse** + +__可选__|publishingHouse|string +|**Query**|**thumbnail** + +__可选__|thumbnail|string +|**Query**|**token** + +__可选__|token|string +|=== + + +===== 响应 + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP代码|说明|类型 +|**200**|OK|<<_commonreturntype,CommonReturnType>> +|**401**|Unauthorized|无内容 +|**403**|Forbidden|无内容 +|**404**|Not Found|无内容 +|=== + + +===== 生成 + +* `\*/*` + + +===== HTTP请求示例 + +====== 请求 path +---- +/api/book/add +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + [[_getusingget]] ==== 获取书籍信息 .... @@ -166,14 +244,14 @@ Category Controller [[_getusingget_1]] -==== 获取书籍分类 +==== 获取指定分类 .... GET /api/category/get .... ===== 说明 -获取书籍分类 +获取指定的书籍分类 ===== 参数 @@ -223,30 +301,15 @@ __必填__|id|integer (int32) ---- -[[_9083a36b9e1b060bcb75ff62bb4bda37]] -=== 用户操作 -User Controller - - -[[_getuserstatususingget]] -==== 获取用户登录状态 +[[_getallusingget]] +==== 获取所有分类 .... -GET /api/user/getUserStatus +GET /api/category/list .... ===== 说明 -获取用户登录状态 - - -===== 参数 - -[options="header", cols=".^2a,.^3a,.^9a,.^4a"] -|=== -|类型|名称|说明|类型 -|**Query**|**token** + -__必填__|token|string -|=== +获取所有的书籍分类 ===== 响应 @@ -270,7 +333,83 @@ __必填__|token|string ====== 请求 path ---- -/api/user/getUserStatus?token=string +/api/category/list +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + +[[_9083a36b9e1b060bcb75ff62bb4bda37]] +=== 用户操作 +User Controller + + +[[_getuserstatususingpost]] +==== 获取用户登录状态 +.... +POST /api/user/getUserStatus +.... + + +===== 说明 +获取用户登录状态 + + +===== 参数 + +[options="header", cols=".^2a,.^3a,.^4a"] +|=== +|类型|名称|类型 +|**FormData**|**token** + +__可选__|string +|=== + + +===== 响应 + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP代码|说明|类型 +|**200**|OK|<<_commonreturntype,CommonReturnType>> +|**201**|Created|无内容 +|**401**|Unauthorized|无内容 +|**403**|Forbidden|无内容 +|**404**|Not Found|无内容 +|=== + + +===== 消耗 + +* `application/x-www-form-urlencoded` + + +===== 生成 + +* `\*/*` + + +===== HTTP请求示例 + +====== 请求 path +---- +/api/user/getUserStatus +---- + + +====== 请求 formData +[source,json] +---- +"string" ---- @@ -359,10 +498,10 @@ __可选__|string ---- -[[_logoutusingget]] +[[_logoutusingpost]] ==== 用户登出 .... -GET /api/user/logout +POST /api/user/logout .... @@ -370,13 +509,101 @@ GET /api/user/logout 用户退出登录 +===== 参数 + +[options="header", cols=".^2a,.^3a,.^4a"] +|=== +|类型|名称|类型 +|**FormData**|**token** + +__可选__|string +|=== + + +===== 响应 + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP代码|说明|类型 +|**200**|OK|<<_commonreturntype,CommonReturnType>> +|**201**|Created|无内容 +|**401**|Unauthorized|无内容 +|**403**|Forbidden|无内容 +|**404**|Not Found|无内容 +|=== + + +===== 消耗 + +* `application/x-www-form-urlencoded` + + +===== 生成 + +* `\*/*` + + +===== HTTP请求示例 + +====== 请求 path +---- +/api/user/logout +---- + + +====== 请求 formData +[source,json] +---- +"string" +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + +[[_4b02b6687df4f15fab50b8d31c1fc123]] +=== 第三方登录 +Third Party Controller + + +[[_qqusingget]] +==== 快捷登录回调函数 +.... +GET /api/third-party/callback/{platform} +.... + + +===== 说明 +传入 code 值，进行登录 + + ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 -|**Query**|**token** + -__必填__|token|string +|**Path**|**platform** + +__必填__|platform|string +|**Query**|**auth_code** + +__可选__||string +|**Query**|**authorization_code** + +__可选__||string +|**Query**|**code** + +__可选__||string +|**Query**|**oauth_token** + +__可选__||string +|**Query**|**oauth_verifier** + +__可选__||string +|**Query**|**state** + +__可选__||string |=== @@ -401,7 +628,141 @@ __必填__|token|string ====== 请求 path ---- -/api/user/logout?token=string +/api/third-party/callback/string +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + +[[_loginusingget]] +==== 第三方用户登录跳转地址 +.... +GET /api/third-party/login +.... + + +===== 说明 +传入需要登录的第三方平台（大小写均可），返回跳转url + + +===== 参数 + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|类型|名称|说明|类型 +|**Query**|**platform** + +__必填__|platform|string +|=== + + +===== 响应 + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP代码|说明|类型 +|**200**|OK|<<_commonreturntype,CommonReturnType>> +|**401**|Unauthorized|无内容 +|**403**|Forbidden|无内容 +|**404**|Not Found|无内容 +|=== + + +===== 生成 + +* `\*/*` + + +===== HTTP请求示例 + +====== 请求 path +---- +/api/third-party/login?platform=string +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + +[[_aca0f16a4237edba915fe70c9b07871c]] +=== 系统调试接口 +Debug Controller + + +[[_statususingpost]] +==== 获取系统配置 +.... +POST /api/debug/status +.... + + +===== 说明 +仅限管理员登录状态下可获取 + + +===== 参数 + +[options="header", cols=".^2a,.^3a,.^4a"] +|=== +|类型|名称|类型 +|**FormData**|**token** + +__可选__|string +|=== + + +===== 响应 + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP代码|说明|类型 +|**200**|OK|<<_commonreturntype,CommonReturnType>> +|**201**|Created|无内容 +|**401**|Unauthorized|无内容 +|**403**|Forbidden|无内容 +|**404**|Not Found|无内容 +|=== + + +===== 消耗 + +* `application/x-www-form-urlencoded` + + +===== 生成 + +* `\*/*` + + +===== HTTP请求示例 + +====== 请求 path +---- +/api/debug/status +---- + + +====== 请求 formData +[source,json] +---- +"string" ---- diff --git a/bookshelfplus/docs/asciidoc/html/all.html b/bookshelfplus/docs/asciidoc/html/all.html index 3978611..7bd2c71 100644 --- a/bookshelfplus/docs/asciidoc/html/all.html +++ b/bookshelfplus/docs/asciidoc/html/all.html @@ -534,7 +534,9 @@ table.CodeRay td.code>pre{padding:0}
  • 2.1. 书籍信息
  • 2.2. 书籍分类信息
  • 2.3. 用户操作
    • -
  • 2.4. 网站后台状态检测
    • +
  • 2.4. 第三方登录
    • +
  • 2.5. 系统调试接口
    • +
  • 2.6. 网站后台状态检测
  • 3. 定义 @@ -578,6 +580,12 @@ table.CodeRay td.code>pre{padding:0}

    用户操作 : User Controller

  • +

    第三方登录 : Third Party Controller

    +
    • +
  • +

    系统调试接口 : Debug Controller

    +
    • +

  • 网站后台状态检测 : Status Controller

    • @@ -594,16 +602,16 @@ table.CodeRay td.code>pre{padding:0}

    Book Controller

    -

    2.1.1. 获取书籍信息

    +

    2.1.1. 【管理员】添加书籍

    -
    GET /api/book/get
    +
    GET /api/book/add
    说明
    -

    获取书籍信息

    +

    管理员在后台添加书籍

    @@ -629,16 +637,151 @@ table.CodeRay td.code>pre{padding:0}

    Query

    -

    id
    -必填

    +

    author
    +可选

    -

    id

    +

    author

    +
    +
    +

    string

    +
    + + +
    +

    Query

    +
    +
    +

    bookName
    +可选

    +
    +
    +

    bookName

    +
    +
    +

    string

    +
    + + +
    +

    Query

    +
    +
    +

    categoryId
    +可选

    +
    +
    +

    categoryId

    integer (int32)

    + +
    +

    Query

    +
    +
    +

    copyright
    +可选

    +
    +
    +

    copyright

    +
    +
    +

    string

    +
    + + +
    +

    Query

    +
    +
    +

    description
    +可选

    +
    +
    +

    description

    +
    +
    +

    string

    +
    + + +
    +

    Query

    +
    +
    +

    isDelete
    +可选

    +
    +
    +

    isDelete

    +
    +
    +

    boolean

    +
    + + +
    +

    Query

    +
    +
    +

    language
    +可选

    +
    +
    +

    language

    +
    +
    +

    string

    +
    + + +
    +

    Query

    +
    +
    +

    publishingHouse
    +可选

    +
    +
    +

    publishingHouse

    +
    +
    +

    string

    +
    + + +
    +

    Query

    +
    +
    +

    thumbnail
    +可选

    +
    +
    +

    thumbnail

    +
    +
    +

    string

    +
    + + +
    +

    Query

    +
    +
    +

    token
    +可选

    +
    +
    +

    token

    +
    +
    +

    string

    +
    + @@ -721,7 +864,7 @@ table.CodeRay td.code>pre{padding:0}
    请求 path
    -
    /api/book/get?id=0
    +
    /api/book/add
    @@ -742,20 +885,168 @@ table.CodeRay td.code>pre{padding:0}
    -

    2.1.2. 查询书籍列表

    +

    2.1.2. 获取书籍信息

    +
    +
    +
    GET /api/book/get
    +
    +
    +
    +
    说明
    +
    +

    获取书籍信息

    +
    +
    +
    +
    参数
    + ++++++ + + + + + + + + + + + + + + + + +
    类型名称说明类型
    +

    Query

    +
    +

    id
    +必填

    +
    +

    id

    +
    +

    integer (int32)

    +
    +
    +
    +
    响应
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP代码说明类型
    +

    200

    +
    +

    OK

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    无内容

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    无内容

    +
    +

    404

    +
    +

    Not Found

    +
    +

    无内容

    +
    +
    +
    +
    生成
    +
    +
      +
    • +

      */*

      +
      • +
    +
    +
    +
    +
    HTTP请求示例
    +
    +
    请求 path
    +
    +
    +
    /api/book/get?id=0
    +
    +
    +
    +
    +
    +
    HTTP响应示例
    +
    +
    响应 200
    +
    +
    +
    {
+  "data" : "object",
+  "status" : "string"
+}
    +
    +
    +
    +
    +
    +
    +

    2.1.3. 查询书籍列表

    GET /api/book/search
    -
    说明
    +
    说明

    通过指定条件查询书籍列表

    -
    参数
    +
    参数
    @@ -866,160 +1157,6 @@ table.CodeRay td.code>pre{padding:0}
    -
    响应
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HTTP代码说明类型
    -

    200

    -
    -

    OK

    -
    -

    401

    -
    -

    Unauthorized

    -
    -

    无内容

    -
    -

    403

    -
    -

    Forbidden

    -
    -

    无内容

    -
    -

    404

    -
    -

    Not Found

    -
    -

    无内容

    -
    -
    -
    -
    生成
    -
    -
      -
    • -

      */*

      -
      • -
    -
    -
    -
    -
    HTTP请求示例
    -
    -
    请求 path
    -
    -
    -
    /api/book/search
    -
    -
    -
    -
    -
    -
    HTTP响应示例
    -
    -
    响应 200
    -
    -
    -
    {
-  "data" : "object",
-  "status" : "string"
-}
    -
    -
    -
    -
    -
    - -
    -

    2.2. 书籍分类信息

    -
    -

    Category Controller

    -
    -
    -

    2.2.1. 获取书籍分类

    -
    -
    -
    GET /api/category/get
    -
    -
    -
    -
    说明
    -
    -

    获取书籍分类

    -
    -
    -
    -
    参数
    - ------ - - - - - - - - - - - - - - - - -
    类型名称说明类型
    -

    Query

    -
    -

    id
    -必填

    -
    -

    id

    -
    -

    integer (int32)

    -
    -
    -
    响应
    @@ -1098,7 +1235,7 @@ table.CodeRay td.code>pre{padding:0}
    请求 path
    -
    /api/category/get?id=0
    +
    /api/book/search
    @@ -1120,21 +1257,21 @@ table.CodeRay td.code>pre{padding:0}
    -

    2.3. 用户操作

    +

    2.2. 书籍分类信息

    -

    User Controller

    +

    Category Controller

    -

    2.3.1. 获取用户登录状态

    +

    2.2.1. 获取指定分类

    -
    GET /api/user/getUserStatus
    +
    GET /api/category/get
    说明
    -

    获取用户登录状态

    +

    获取指定的书籍分类

    @@ -1160,14 +1297,14 @@ table.CodeRay td.code>pre{padding:0}

    Query

    @@ -1252,7 +1389,7 @@ table.CodeRay td.code>pre{padding:0}
    请求 path
    -
    /api/user/getUserStatus?token=string
    +
    /api/category/get?id=0
    @@ -1273,16 +1410,134 @@ table.CodeRay td.code>pre{padding:0}
    -

    2.3.2. 用户登录

    +

    2.2.2. 获取所有分类

    -
    POST /api/user/login
    +
    GET /api/category/list
    说明
    -

    传入用户名，以及密码明文，后台计算密码SHA1值，进行登录

    +

    获取所有的书籍分类

    +
    +
    +
    +
    响应
    +
    -

    token
    +

    id
    必填
    -

    token

    +

    id
    -

    string

    +

    integer (int32)
    +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP代码说明类型
    +

    200

    +
    +

    OK

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    无内容

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    无内容

    +
    +

    404

    +
    +

    Not Found

    +
    +

    无内容

    +
    +
    +
    +
    生成
    +
    +
      +
    • +

      */*

      +
      • +
    +
    +
    +
    +
    HTTP请求示例
    +
    +
    请求 path
    +
    +
    +
    /api/category/list
    +
    +
    +
    +
    +
    +
    HTTP响应示例
    +
    +
    响应 200
    +
    +
    +
    {
+  "data" : "object",
+  "status" : "string"
+}
    +
    +
    +
    +
    +
    +
    +
    +

    2.3. 用户操作

    +
    +

    User Controller

    +
    +
    +

    2.3.1. 获取用户登录状态

    +
    +
    +
    POST /api/user/getUserStatus
    +
    +
    +
    +
    说明
    +
    +

    获取用户登录状态

    @@ -1306,19 +1561,7 @@ table.CodeRay td.code>pre{padding:0}

    FormData

    -

    password
    -可选

    -
    -
    -

    string

    -
    - - -
    -

    FormData

    -
    -
    -

    username
    +

    token
    可选

    @@ -1329,7 +1572,7 @@ table.CodeRay td.code>pre{padding:0}
    -
    响应
    +
    响应
    @@ -1413,162 +1656,6 @@ table.CodeRay td.code>pre{padding:0}
    -
    生成
    -
    -
      -
    • -

      */*

      -
      • -
    -
    -
    -
    -
    HTTP请求示例
    -
    -
    请求 path
    -
    -
    -
    /api/user/login
    -
    -
    -
    -
    -
    请求 formData
    -
    -
    -
    "string"
    -
    -
    -
    -
    -
    -
    HTTP响应示例
    -
    -
    响应 200
    -
    -
    -
    {
-  "data" : "object",
-  "status" : "string"
-}
    -
    -
    -
    -
    - -
    -

    2.3.3. 用户登出

    -
    -
    -
    GET /api/user/logout
    -
    -
    -
    -
    说明
    -
    -

    用户退出登录

    -
    -
    -
    -
    参数
    -
    ------ - - - - - - - - - - - - - - - - -
    类型名称说明类型
    -

    Query

    -
    -

    token
    -必填

    -
    -

    token

    -
    -

    string

    -
    -
    -
    -
    响应
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HTTP代码说明类型
    -

    200

    -
    -

    OK

    -
    -

    401

    -
    -

    Unauthorized

    -
    -

    无内容

    -
    -

    403

    -
    -

    Forbidden

    -
    -

    无内容

    -
    -

    404

    -
    -

    Not Found

    -
    -

    无内容

    -
    -
    -
    生成
      @@ -1584,7 +1671,15 @@ table.CodeRay td.code>pre{padding:0}
      请求 path
      -
      /api/user/logout?token=string
      +
      /api/user/getUserStatus
      +
      +
      +
    +
    +
    请求 formData
    +
    +
    +
    "string"
    @@ -1604,26 +1699,63 @@ table.CodeRay td.code>pre{padding:0}
    - -
    -

    2.4. 网站后台状态检测

    -
    -

    Status Controller

    -
    -

    2.4.1. 系统状态

    +

    2.3.2. 用户登录

    -
    GET /api/status/get
    +
    POST /api/user/login
    说明
    -

    获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。

    +

    传入用户名，以及密码明文，后台计算密码SHA1值，进行登录

    +
    参数
    + +++++ + + + + + + + + + + + + + + + + + + + +
    类型名称类型
    +

    FormData

    +
    +

    password
    +可选

    +
    +

    string

    +
    +

    FormData

    +
    +

    username
    +可选

    +
    +

    string

    +
    +
    +
    响应
    @@ -1652,6 +1784,17 @@ table.CodeRay td.code>pre{padding:0} + + + + +
    +

    201

    +
    +

    Created

    +
    +

    无内容

    +

    401
    @@ -1687,6 +1830,16 @@ table.CodeRay td.code>pre{padding:0}
    +
    消耗
    +
    +
      +
    • +

      application/x-www-form-urlencoded

      +
      • +
    +
    +
    +
    生成
      @@ -1702,7 +1855,15 @@ table.CodeRay td.code>pre{padding:0}
      请求 path
      -
      /api/status/get
      +
      /api/user/login
      +
      +
      +
    +
    +
    请求 formData
    +
    +
    +
    "string"
    @@ -1722,6 +1883,854 @@ table.CodeRay td.code>pre{padding:0}
    +
    +

    2.3.3. 用户登出

    +
    +
    +
    POST /api/user/logout
    +
    +
    +
    +
    说明
    +
    +

    用户退出登录

    +
    +
    +
    +
    参数
    + +++++ + + + + + + + + + + + + + + +
    类型名称类型
    +

    FormData

    +
    +

    token
    +可选

    +
    +

    string

    +
    +
    +
    +
    响应
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP代码说明类型
    +

    200

    +
    +

    OK

    +
    +

    201

    +
    +

    Created

    +
    +

    无内容

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    无内容

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    无内容

    +
    +

    404

    +
    +

    Not Found

    +
    +

    无内容

    +
    +
    +
    +
    消耗
    +
    +
      +
    • +

      application/x-www-form-urlencoded

      +
      • +
    +
    +
    +
    +
    生成
    +
    +
      +
    • +

      */*

      +
      • +
    +
    +
    +
    +
    HTTP请求示例
    +
    +
    请求 path
    +
    +
    +
    /api/user/logout
    +
    +
    +
    +
    +
    请求 formData
    +
    +
    +
    "string"
    +
    +
    +
    +
    +
    +
    HTTP响应示例
    +
    +
    响应 200
    +
    +
    +
    {
+  "data" : "object",
+  "status" : "string"
+}
    +
    +
    +
    +
    +
    + +
    +

    2.4. 第三方登录

    +
    +

    Third Party Controller

    +
    +
    +

    2.4.1. 快捷登录回调函数

    +
    +
    +
    GET /api/third-party/callback/{platform}
    +
    +
    +
    +
    说明
    +
    +

    传入 code 值，进行登录

    +
    +
    +
    +
    参数
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    类型名称说明类型
    +

    Path

    +
    +

    platform
    +必填

    +
    +

    platform

    +
    +

    string

    +
    +

    Query

    +
    +

    auth_code
    +可选

    +
    +

    string

    +
    +

    Query

    +
    +

    authorization_code
    +可选

    +
    +

    string

    +
    +

    Query

    +
    +

    code
    +可选

    +
    +

    string

    +
    +

    Query

    +
    +

    oauth_token
    +可选

    +
    +

    string

    +
    +

    Query

    +
    +

    oauth_verifier
    +可选

    +
    +

    string

    +
    +

    Query

    +
    +

    state
    +可选

    +
    +

    string

    +
    +
    +
    +
    响应
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP代码说明类型
    +

    200

    +
    +

    OK

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    无内容

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    无内容

    +
    +

    404

    +
    +

    Not Found

    +
    +

    无内容

    +
    +
    +
    +
    生成
    +
    +
      +
    • +

      */*

      +
      • +
    +
    +
    +
    +
    HTTP请求示例
    +
    +
    请求 path
    +
    +
    +
    /api/third-party/callback/string
    +
    +
    +
    +
    +
    +
    HTTP响应示例
    +
    +
    响应 200
    +
    +
    +
    {
+  "data" : "object",
+  "status" : "string"
+}
    +
    +
    +
    +
    +
    +
    +

    2.4.2. 第三方用户登录跳转地址

    +
    +
    +
    GET /api/third-party/login
    +
    +
    +
    +
    说明
    +
    +

    传入需要登录的第三方平台（大小写均可），返回跳转url

    +
    +
    +
    +
    参数
    + ++++++ + + + + + + + + + + + + + + + + +
    类型名称说明类型
    +

    Query

    +
    +

    platform
    +必填

    +
    +

    platform

    +
    +

    string

    +
    +
    +
    +
    响应
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP代码说明类型
    +

    200

    +
    +

    OK

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    无内容

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    无内容

    +
    +

    404

    +
    +

    Not Found

    +
    +

    无内容

    +
    +
    +
    +
    生成
    +
    +
      +
    • +

      */*

      +
      • +
    +
    +
    +
    +
    HTTP请求示例
    +
    +
    请求 path
    +
    +
    +
    /api/third-party/login?platform=string
    +
    +
    +
    +
    +
    +
    HTTP响应示例
    +
    +
    响应 200
    +
    +
    +
    {
+  "data" : "object",
+  "status" : "string"
+}
    +
    +
    +
    +
    +
    +
    +
    +

    2.5. 系统调试接口

    +
    +

    Debug Controller

    +
    +
    +

    2.5.1. 获取系统配置

    +
    +
    +
    POST /api/debug/status
    +
    +
    +
    +
    说明
    +
    +

    仅限管理员登录状态下可获取

    +
    +
    +
    +
    参数
    + +++++ + + + + + + + + + + + + + + +
    类型名称类型
    +

    FormData

    +
    +

    token
    +可选

    +
    +

    string

    +
    +
    +
    +
    响应
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP代码说明类型
    +

    200

    +
    +

    OK

    +
    +

    201

    +
    +

    Created

    +
    +

    无内容

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    无内容

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    无内容

    +
    +

    404

    +
    +

    Not Found

    +
    +

    无内容

    +
    +
    +
    +
    消耗
    +
    +
      +
    • +

      application/x-www-form-urlencoded

      +
      • +
    +
    +
    +
    +
    生成
    +
    +
      +
    • +

      */*

      +
      • +
    +
    +
    +
    +
    HTTP请求示例
    +
    +
    请求 path
    +
    +
    +
    /api/debug/status
    +
    +
    +
    +
    +
    请求 formData
    +
    +
    +
    "string"
    +
    +
    +
    +
    +
    +
    HTTP响应示例
    +
    +
    响应 200
    +
    +
    +
    {
+  "data" : "object",
+  "status" : "string"
+}
    +
    +
    +
    +
    +
    +
    +
    +

    2.6. 网站后台状态检测

    +
    +

    Status Controller

    +
    +
    +

    2.6.1. 系统状态

    +
    +
    +
    GET /api/status/get
    +
    +
    +
    +
    说明
    +
    +

    获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。

    +
    +
    +
    +
    响应
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP代码说明类型
    +

    200

    +
    +

    OK

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    无内容

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    无内容

    +
    +

    404

    +
    +

    Not Found

    +
    +

    无内容

    +
    +
    +
    +
    生成
    +
    +
      +
    • +

      */*

      +
      • +
    +
    +
    +
    +
    HTTP请求示例
    +
    +
    请求 path
    +
    +
    +
    /api/status/get
    +
    +
    +
    +
    +
    +
    HTTP响应示例
    +
    +
    响应 200
    +
    +
    +
    {
+  "data" : "object",
+  "status" : "string"
+}
    +
    +
    +
    +
    +
    @@ -1776,7 +2785,7 @@ table.CodeRay td.code>pre{padding:0}