From bde9ffe5525b50b576aebe9eb2abb260a0bb2428 Mon Sep 17 00:00:00 2001 From: Dynesshely Date: Wed, 6 Mar 2024 01:19:23 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Docs:=20Updated.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- KitX Docs.code-workspace | 10 ++++++ docs/en/mobile/guide/packages.md | 4 +-- docs/mobile/guide/packages.md | 4 +-- docs/rules/network/kitx-dashboard-network.md | 33 ++------------------ 4 files changed, 16 insertions(+), 35 deletions(-) create mode 100644 KitX Docs.code-workspace diff --git a/KitX Docs.code-workspace b/KitX Docs.code-workspace new file mode 100644 index 00000000..597b3d66 --- /dev/null +++ b/KitX Docs.code-workspace @@ -0,0 +1,10 @@ +{ + "folders": [ + { + "path": "." + } + ], + "settings": { + "git.autorefresh": true + } +} diff --git a/docs/en/mobile/guide/packages.md b/docs/en/mobile/guide/packages.md index 33012b3e..7764118b 100644 --- a/docs/en/mobile/guide/packages.md +++ b/docs/en/mobile/guide/packages.md @@ -53,7 +53,7 @@ const L = (props, _) => h( - + @@ -65,7 +65,7 @@ const L = (props, _) => h( - + diff --git a/docs/mobile/guide/packages.md b/docs/mobile/guide/packages.md index 2c85b6e8..9c110788 100644 --- a/docs/mobile/guide/packages.md +++ b/docs/mobile/guide/packages.md @@ -53,7 +53,7 @@ const L = (props, _) => h( - + @@ -65,7 +65,7 @@ const L = (props, _) => h( - + diff --git a/docs/rules/network/kitx-dashboard-network.md b/docs/rules/network/kitx-dashboard-network.md index bd19304e..07ecef12 100644 --- a/docs/rules/network/kitx-dashboard-network.md +++ b/docs/rules/network/kitx-dashboard-network.md @@ -36,35 +36,6 @@ description: 这篇文章是有关 KitX Dashboard 网络 > > 报文协议: [KWC](kitx-web-command.md) -暴露如下 APIs +在本地访问 `http://localhost:/swagger` 可以打开 Swagger -### /Device - -- `[GET]` / - - `[FromQuery]` Token // 访问令牌 - - 获取设备信息 -- `[POST]` /ExchangeKey - - `[FromQuery]` Key // 密钥 - - `[FromQuery]` KeyId // 密钥标识 - - `[FromQuery]` DecryptionVerifyCode // 密钥解密验证码 - - 发起密钥交换流程 -- `[POST]` /ExchangeKeyBack - - `[FromQuery]` Key // 本机密钥 - - `[FromQuery]` KeyId // 密钥标识 - - 返回本机密钥 (由被调用 /ExchangeKey 的设备向发起方调用该 API 来完成密钥交换过程) -- `[POST]` /Swap - - `[FromQuery]` Token // 访问令牌 - - // ToDo - - 移交主控 (由主控向从控发起) -- `[GET]` /Connect - - `[FromQuery]` KeyId // 密钥标识 - - `[FromQuery]` VerifyCode // 验证码 - - `[FromQuery]` VerifyAnwser // 验证答案 - - `[FromQuery]` GivenToken // 加密的 Client Token - - Host 根据 KeyId 使用对应的 Key 解密 VerifyCode, 若结果与 VerifyAnwser 一致, 则身份验证通过, 解密并存储 Client Token, 返回 Host Token - -### /Plugin - -- `[GET]` /Request - - `[FromQuery]` Token // 访问令牌 - - `[FromQuery]` Request // 请求报文 ([KWC](kitx-web-command.md) 格式) +在线 Api 文档我们正在开发, 请稍安勿躁 ~