From fb2cfd70cb2f772d3eb5567d24278c9e5a32a4f8 Mon Sep 17 00:00:00 2001 From: Jason Lee Date: Mon, 20 May 2024 16:32:58 +0800 Subject: [PATCH] =?UTF-8?q?=E7=A7=BB=E5=8A=A8=E2=80=9C=E5=87=86=E5=A4=87?= =?UTF-8?q?=E5=BC=80=E5=8F=91=E2=80=9D=E5=92=8C=E2=80=9C=E9=95=BF=E8=BF=9E?= =?UTF-8?q?=E6=8E=A5=E2=80=9D=EF=BC=8C=E7=BB=84=E7=BB=87=E5=88=B0=20?= =?UTF-8?q?=E2=80=9DAPI=20=E9=99=84=E5=BD=95=E2=80=9C=20=E4=B8=8B=E9=9D=A2?= =?UTF-8?q?=E5=B9=B6=E9=BB=98=E8=AE=A4=E6=8A=98=E5=8F=A0=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api-reference/_category_.json | 7 +++++++ .../error-codes.md | 0 .../how-to-access-api.md | 12 ++++++++++-- .../refresh-token-api.md | 0 docs/{ => api-reference}/socket/_category_.json | 2 +- docs/{ => api-reference}/socket/biz-command.md | 0 .../socket/control-command.md | 0 docs/{ => api-reference}/socket/diff-ws-tcp.md | 0 docs/{ => api-reference}/socket/hosts.md | 0 .../socket/how_to_subscribe_quote.md | 0 .../socket/how_to_subscribe_trade.md | 0 .../socket/protocol/_category_.json | 2 +- .../socket/protocol/connect.md | 0 .../socket/protocol/how-to-parse-header.md | 0 .../socket/protocol/how-to-parse-push.md | 0 .../socket/protocol/how-to-parse-request.md | 0 .../socket/protocol/how-to-parse-response.md | 0 .../socket/protocol/how_to_handshake.md | 0 .../socket/protocol/protocol_overview.md | 0 .../{ => api-reference}/socket/socket-otp-api.md | 0 docs/getting-developed/_category_.json | 7 ------- docs/getting-started.md | 14 +++++--------- docs/quote/_category_.json | 2 +- docs/socket/overview.md | 16 ---------------- docs/trade/_category_.json | 2 +- .../current/api-reference/_category_.json | 7 +++++++ .../error-codes.md | 0 .../how-to-access-api.md | 12 ++++++++++-- .../refresh-token-api.md | 0 .../{ => api-reference}/socket/_category_.json | 0 .../{ => api-reference}/socket/biz-command.md | 0 .../socket/control-command.md | 0 .../{ => api-reference}/socket/diff-ws-tcp.md | 0 .../current/{ => api-reference}/socket/hosts.md | 0 .../socket/how_to_subscribe_quote.md | 0 .../socket/how_to_subscribe_trade.md | 0 .../socket/protocol/_category_.json | 2 +- .../socket/protocol/connect.md | 0 .../socket/protocol/how-to-parse-header.md | 0 .../socket/protocol/how-to-parse-push.md | 0 .../socket/protocol/how-to-parse-request.md | 0 .../socket/protocol/how-to-parse-response.md | 0 .../socket/protocol/how_to_handshake.md | 0 .../socket/protocol/protocol_overview.md | 0 .../{ => api-reference}/socket/socket-otp-api.md | 0 .../current/getting-developed/_category_.json | 7 ------- .../current/getting-started.md | 6 ++++-- .../current/socket/overview.md | 16 ---------------- .../current/api-reference/_category_.json | 7 +++++++ .../error-codes.md | 0 .../how-to-access-api.md | 12 ++++++++++-- .../refresh-token-api.md | 0 .../{ => api-reference}/socket/_category_.json | 0 .../{ => api-reference}/socket/biz-command.md | 0 .../socket/control-command.md | 0 .../{ => api-reference}/socket/diff-ws-tcp.md | 0 .../current/{ => api-reference}/socket/hosts.md | 0 .../socket/how_to_subscribe_quote.md | 0 .../socket/how_to_subscribe_trade.md | 0 .../socket/protocol/_category_.json | 0 .../socket/protocol/connect.md | 0 .../socket/protocol/how-to-parse-header.md | 0 .../socket/protocol/how-to-parse-push.md | 0 .../socket/protocol/how-to-parse-request.md | 0 .../socket/protocol/how-to-parse-response.md | 0 .../socket/protocol/how_to_handshake.md | 0 .../socket/protocol/protocol_overview.md | 0 .../{ => api-reference}/socket/socket-otp-api.md | 0 .../current/getting-developed/_category_.json | 7 ------- .../current/getting-started.md | 14 ++++++-------- .../current/quote/_category_.json | 2 +- .../current/socket/overview.md | 16 ---------------- .../current/trade/_category_.json | 2 +- 73 files changed, 73 insertions(+), 101 deletions(-) create mode 100644 docs/api-reference/_category_.json rename docs/{getting-developed => api-reference}/error-codes.md (100%) rename docs/{getting-developed => api-reference}/how-to-access-api.md (95%) rename docs/{getting-developed => api-reference}/refresh-token-api.md (100%) rename docs/{ => api-reference}/socket/_category_.json (79%) rename docs/{ => api-reference}/socket/biz-command.md (100%) rename docs/{ => api-reference}/socket/control-command.md (100%) rename docs/{ => api-reference}/socket/diff-ws-tcp.md (100%) rename docs/{ => api-reference}/socket/hosts.md (100%) rename docs/{ => api-reference}/socket/how_to_subscribe_quote.md (100%) rename docs/{ => api-reference}/socket/how_to_subscribe_trade.md (100%) rename docs/{ => api-reference}/socket/protocol/_category_.json (79%) rename docs/{ => api-reference}/socket/protocol/connect.md (100%) rename docs/{ => api-reference}/socket/protocol/how-to-parse-header.md (100%) rename docs/{ => api-reference}/socket/protocol/how-to-parse-push.md (100%) rename docs/{ => api-reference}/socket/protocol/how-to-parse-request.md (100%) rename docs/{ => api-reference}/socket/protocol/how-to-parse-response.md (100%) rename docs/{ => api-reference}/socket/protocol/how_to_handshake.md (100%) rename docs/{ => api-reference}/socket/protocol/protocol_overview.md (100%) rename docs/{ => api-reference}/socket/socket-otp-api.md (100%) delete mode 100644 docs/getting-developed/_category_.json delete mode 100644 docs/socket/overview.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/current/api-reference/_category_.json rename i18n/en/docusaurus-plugin-content-docs/current/{getting-developed => api-reference}/error-codes.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{getting-developed => api-reference}/how-to-access-api.md (95%) rename i18n/en/docusaurus-plugin-content-docs/current/{getting-developed => api-reference}/refresh-token-api.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/_category_.json (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/biz-command.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/control-command.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/diff-ws-tcp.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/hosts.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/how_to_subscribe_quote.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/how_to_subscribe_trade.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/_category_.json (78%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/connect.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-header.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-push.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-request.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-response.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how_to_handshake.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/protocol_overview.md (100%) rename i18n/en/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/socket-otp-api.md (100%) delete mode 100644 i18n/en/docusaurus-plugin-content-docs/current/getting-developed/_category_.json delete mode 100644 i18n/en/docusaurus-plugin-content-docs/current/socket/overview.md create mode 100644 i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/_category_.json rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{getting-developed => api-reference}/error-codes.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{getting-developed => api-reference}/how-to-access-api.md (95%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{getting-developed => api-reference}/refresh-token-api.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/_category_.json (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/biz-command.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/control-command.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/diff-ws-tcp.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/hosts.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/how_to_subscribe_quote.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/how_to_subscribe_trade.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/_category_.json (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/connect.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-header.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-push.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-request.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how-to-parse-response.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/how_to_handshake.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/protocol/protocol_overview.md (100%) rename i18n/zh-HK/docusaurus-plugin-content-docs/current/{ => api-reference}/socket/socket-otp-api.md (100%) delete mode 100644 i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/_category_.json delete mode 100644 i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/overview.md diff --git a/docs/api-reference/_category_.json b/docs/api-reference/_category_.json new file mode 100644 index 00000000..85799dc6 --- /dev/null +++ b/docs/api-reference/_category_.json @@ -0,0 +1,7 @@ +{ + "position": 4.5, + "label": "API 附录", + "collapsible": true, + "collapsed": true, + "link": null +} diff --git a/docs/getting-developed/error-codes.md b/docs/api-reference/error-codes.md similarity index 100% rename from docs/getting-developed/error-codes.md rename to docs/api-reference/error-codes.md diff --git a/docs/getting-developed/how-to-access-api.md b/docs/api-reference/how-to-access-api.md similarity index 95% rename from docs/getting-developed/how-to-access-api.md rename to docs/api-reference/how-to-access-api.md index d2aa2496..6420c2e9 100644 --- a/docs/getting-developed/how-to-access-api.md +++ b/docs/api-reference/how-to-access-api.md @@ -1,11 +1,19 @@ --- -title: 如何调用 API +title: Overview id: how-to-access-api slug: /how-to-access-api sidebar_position: 1 --- -## 开发前须知 +本部分内容主要介绍 LongPort OpenAPI 的基础信息，包括如何访问 API、如何使用 API、如何获取 API 接口文档等，内容比较原始。 + +:::success 提示 +建议可以直接采用 SDK 的方式访问 API，SDK 已经封装了 API 的调用方式，使用起来更加方便。 + +https://open.longportapp.com/sdk +::: + +## API 须知 | 注意事项 | 参考文档 | | -------------------------------------------- | ------------------------------------------------- | diff --git a/docs/getting-developed/refresh-token-api.md b/docs/api-reference/refresh-token-api.md similarity index 100% rename from docs/getting-developed/refresh-token-api.md rename to docs/api-reference/refresh-token-api.md diff --git a/docs/socket/_category_.json b/docs/api-reference/socket/_category_.json similarity index 79% rename from docs/socket/_category_.json rename to docs/api-reference/socket/_category_.json index 6eecef1a..ae722831 100644 --- a/docs/socket/_category_.json +++ b/docs/api-reference/socket/_category_.json @@ -2,6 +2,6 @@ "position": 5, "label": "长连接", "collapsible": true, - "collapsed": false, + "collapsed": true, "link": null } diff --git a/docs/socket/biz-command.md b/docs/api-reference/socket/biz-command.md similarity index 100% rename from docs/socket/biz-command.md rename to docs/api-reference/socket/biz-command.md diff --git a/docs/socket/control-command.md b/docs/api-reference/socket/control-command.md similarity index 100% rename from docs/socket/control-command.md rename to docs/api-reference/socket/control-command.md diff --git a/docs/socket/diff-ws-tcp.md b/docs/api-reference/socket/diff-ws-tcp.md similarity index 100% rename from docs/socket/diff-ws-tcp.md rename to docs/api-reference/socket/diff-ws-tcp.md diff --git a/docs/socket/hosts.md b/docs/api-reference/socket/hosts.md similarity index 100% rename from docs/socket/hosts.md rename to docs/api-reference/socket/hosts.md diff --git a/docs/socket/how_to_subscribe_quote.md b/docs/api-reference/socket/how_to_subscribe_quote.md similarity index 100% rename from docs/socket/how_to_subscribe_quote.md rename to docs/api-reference/socket/how_to_subscribe_quote.md diff --git a/docs/socket/how_to_subscribe_trade.md b/docs/api-reference/socket/how_to_subscribe_trade.md similarity index 100% rename from docs/socket/how_to_subscribe_trade.md rename to docs/api-reference/socket/how_to_subscribe_trade.md diff --git a/docs/socket/protocol/_category_.json b/docs/api-reference/socket/protocol/_category_.json similarity index 79% rename from docs/socket/protocol/_category_.json rename to docs/api-reference/socket/protocol/_category_.json index 658d07cc..c3aa9853 100644 --- a/docs/socket/protocol/_category_.json +++ b/docs/api-reference/socket/protocol/_category_.json @@ -2,6 +2,6 @@ "position": 3, "label": "通信协议", "collapsible": true, - "collapsed": false, + "collapsed": true, "link": null } diff --git a/docs/socket/protocol/connect.md b/docs/api-reference/socket/protocol/connect.md similarity index 100% rename from docs/socket/protocol/connect.md rename to docs/api-reference/socket/protocol/connect.md diff --git a/docs/socket/protocol/how-to-parse-header.md b/docs/api-reference/socket/protocol/how-to-parse-header.md similarity index 100% rename from docs/socket/protocol/how-to-parse-header.md rename to docs/api-reference/socket/protocol/how-to-parse-header.md diff --git a/docs/socket/protocol/how-to-parse-push.md b/docs/api-reference/socket/protocol/how-to-parse-push.md similarity index 100% rename from docs/socket/protocol/how-to-parse-push.md rename to docs/api-reference/socket/protocol/how-to-parse-push.md diff --git a/docs/socket/protocol/how-to-parse-request.md b/docs/api-reference/socket/protocol/how-to-parse-request.md similarity index 100% rename from docs/socket/protocol/how-to-parse-request.md rename to docs/api-reference/socket/protocol/how-to-parse-request.md diff --git a/docs/socket/protocol/how-to-parse-response.md b/docs/api-reference/socket/protocol/how-to-parse-response.md similarity index 100% rename from docs/socket/protocol/how-to-parse-response.md rename to docs/api-reference/socket/protocol/how-to-parse-response.md diff --git a/docs/socket/protocol/how_to_handshake.md b/docs/api-reference/socket/protocol/how_to_handshake.md similarity index 100% rename from docs/socket/protocol/how_to_handshake.md rename to docs/api-reference/socket/protocol/how_to_handshake.md diff --git a/docs/socket/protocol/protocol_overview.md b/docs/api-reference/socket/protocol/protocol_overview.md similarity index 100% rename from docs/socket/protocol/protocol_overview.md rename to docs/api-reference/socket/protocol/protocol_overview.md diff --git a/docs/socket/socket-otp-api.md b/docs/api-reference/socket/socket-otp-api.md similarity index 100% rename from docs/socket/socket-otp-api.md rename to docs/api-reference/socket/socket-otp-api.md diff --git a/docs/getting-developed/_category_.json b/docs/getting-developed/_category_.json deleted file mode 100644 index c4f761c6..00000000 --- a/docs/getting-developed/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "position": 2, - "label": "准备开发", - "collapsible": true, - "collapsed": false, - "link": null -} diff --git a/docs/getting-started.md b/docs/getting-started.md index 4339750d..512b6597 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1037,12 +1037,8 @@ SDK 的详细 API 文档请访问： ## 反馈及沟通 -- GitHub Issues: - -- 微信沟通群（已满）： - - - -- 飞书沟通群： - - +| 渠道 | 二维码 / 链接 | +| ------------------ | ---------------------------------------------------------------------------------------------- | +| GitHub Issues | | +| 微信沟通群（已满） | | +| 飞书沟通群 | | diff --git a/docs/quote/_category_.json b/docs/quote/_category_.json index ecee0631..4a190eb5 100644 --- a/docs/quote/_category_.json +++ b/docs/quote/_category_.json @@ -1,7 +1,7 @@ { "label": "行情", "collapsible": true, - "collapsed": true, + "collapsed": false, "link": null, "position": 3 } diff --git a/docs/socket/overview.md b/docs/socket/overview.md deleted file mode 100644 index 70daeb39..00000000 --- a/docs/socket/overview.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Overview -id: overview -slug: /socket/overview -sidebar_position: -1 ---- - -我们的 OpenAPI 提供 WebSocket 方式连接行情网关，客户端可以通过这两种方式订阅行情。本章节文档将会介绍详细的协议细节。 - -:::success NOTE -我们的 OpenAPI SDK 已经完整实现了订阅行情的功能，你可以直接使用 SDK。 - -https://open.longportapp.com/sdk - -本章节文档提供给大家参考 API 细节。 -::: diff --git a/docs/trade/_category_.json b/docs/trade/_category_.json index eb53f382..0cf4aee6 100644 --- a/docs/trade/_category_.json +++ b/docs/trade/_category_.json @@ -1,7 +1,7 @@ { "label": "交易", "collapsible": true, - "collapsed": true, + "collapsed": false, "position": 4, "link": null } diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api-reference/_category_.json b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/_category_.json new file mode 100644 index 00000000..6b30ef8a --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/_category_.json @@ -0,0 +1,7 @@ +{ + "position": 4.5, + "label": "API Reference", + "collapsible": true, + "collapsed": true, + "link": null +} diff --git a/i18n/en/docusaurus-plugin-content-docs/current/getting-developed/error-codes.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/error-codes.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/getting-developed/error-codes.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/error-codes.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/getting-developed/how-to-access-api.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/how-to-access-api.md similarity index 95% rename from i18n/en/docusaurus-plugin-content-docs/current/getting-developed/how-to-access-api.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/how-to-access-api.md index d7db42de..abe9ec73 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/getting-developed/how-to-access-api.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/how-to-access-api.md @@ -1,11 +1,19 @@ --- -title: How to access an API +title: Overview id: how-to-access-api slug: /how-to-access-api sidebar_position: 1 --- -## Pre-Development Notes +This section mainly introduces the basic information of LongPort OpenAPI, including how to access the API, how to use the API, how to obtain the API interface document, etc., the content is relatively primitive. + +:::success Tip +It is recommended to directly use the SDK to access the API, the SDK has encapsulated the API call method, which is more convenient to use. + +https://open.longportapp.com/sdk +::: + +## Notes | Precautions | Reference Documents | | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/getting-developed/refresh-token-api.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/refresh-token-api.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/getting-developed/refresh-token-api.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/refresh-token-api.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/_category_.json b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/_category_.json similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/_category_.json rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/_category_.json diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/biz-command.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/biz-command.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/biz-command.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/biz-command.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/control-command.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/control-command.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/control-command.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/control-command.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/diff-ws-tcp.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/diff-ws-tcp.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/diff-ws-tcp.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/diff-ws-tcp.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/hosts.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/hosts.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/hosts.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/hosts.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_quote.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_quote.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_quote.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_quote.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_trade.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_trade.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_trade.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_trade.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/_category_.json b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/_category_.json similarity index 78% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/_category_.json rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/_category_.json index ff58e88f..961cc4d2 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/_category_.json +++ b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/_category_.json @@ -2,6 +2,6 @@ "position": 3, "label": "Protocol", "collapsible": true, - "collapsed": false, + "collapsed": true, "link": null } diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/connect.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/connect.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/connect.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/connect.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-header.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-header.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-header.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-header.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-push.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-push.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-push.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-push.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-request.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-request.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-request.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-request.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-response.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-response.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-response.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-response.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how_to_handshake.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how_to_handshake.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/how_to_handshake.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how_to_handshake.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/protocol_overview.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/protocol_overview.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/protocol/protocol_overview.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/protocol_overview.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/socket-otp-api.md b/i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/socket-otp-api.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/socket/socket-otp-api.md rename to i18n/en/docusaurus-plugin-content-docs/current/api-reference/socket/socket-otp-api.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/getting-developed/_category_.json b/i18n/en/docusaurus-plugin-content-docs/current/getting-developed/_category_.json deleted file mode 100644 index 597f7357..00000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/getting-developed/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "position": 2, - "label": "Getting Started", - "collapsible": true, - "collapsed": false, - "link": null -} diff --git a/i18n/en/docusaurus-plugin-content-docs/current/getting-started.md b/i18n/en/docusaurus-plugin-content-docs/current/getting-started.md index cded2e95..17cdc9ab 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/getting-started.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/getting-started.md @@ -1045,5 +1045,7 @@ For detailed SDK API document, please visit: ## Contact & Feedback -- GitHub Issues: -- Join **Discord** LongPort OpenAPI Server: +| Contact | Description | +| ------- | --------------------------------------------------- | +| GitHub | | +| Discord | | diff --git a/i18n/en/docusaurus-plugin-content-docs/current/socket/overview.md b/i18n/en/docusaurus-plugin-content-docs/current/socket/overview.md deleted file mode 100644 index ff5a1742..00000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/socket/overview.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Overview -id: overview -slug: /socket/overview -sidebar_position: -1 ---- - -Our OpenAPI provides WebSocket connection to the market gateway, clients can subscribe to market data through these two methods. This chapter will introduce the detailed protocol details. - -:::success NOTE -Our OpenAPI SDK has fully implemented the function of subscribing to market data, you can use the SDK directly. - -https://open.longportapp.com/sdk - -This chapter provides API details for your reference. -::: diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/_category_.json b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/_category_.json new file mode 100644 index 00000000..858487e7 --- /dev/null +++ b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/_category_.json @@ -0,0 +1,7 @@ +{ + "position": 4.5, + "label": "API 附錄", + "collapsible": true, + "collapsed": true, + "link": null +} diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/error-codes.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/error-codes.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/error-codes.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/error-codes.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/how-to-access-api.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/how-to-access-api.md similarity index 95% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/how-to-access-api.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/how-to-access-api.md index 1eb5fdcf..b1587cac 100644 --- a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/how-to-access-api.md +++ b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/how-to-access-api.md @@ -1,11 +1,19 @@ --- -title: 如何調用 API +title: Overview id: how-to-access-api slug: /how-to-access-api sidebar_position: 1 --- -## 開發前須知 +本部分內容主要介紹 LongPort OpenAPI 的基礎訊息，包括如何存取 API、如何使用 API、如何取得 API 介面文件等，內容較為原始。 + +:::success 提示 +建議可以直接採用 SDK 的方式存取 API，SDK 已經封裝了 API 的呼叫方式，使用起來更方便。 + +https://open.longportapp.com/sdk +::: + +## API 須知 | 注意事項 | 參考文檔 | | -------------------------------------------- | ------------------------------------------------- | diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/refresh-token-api.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/refresh-token-api.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/refresh-token-api.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/refresh-token-api.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/_category_.json b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/_category_.json similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/_category_.json rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/_category_.json diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/biz-command.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/biz-command.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/biz-command.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/biz-command.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/control-command.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/control-command.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/control-command.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/control-command.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/diff-ws-tcp.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/diff-ws-tcp.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/diff-ws-tcp.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/diff-ws-tcp.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/hosts.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/hosts.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/hosts.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/hosts.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_quote.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_quote.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_quote.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_quote.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_trade.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_trade.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/how_to_subscribe_trade.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/how_to_subscribe_trade.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/_category_.json b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/_category_.json similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/_category_.json rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/_category_.json diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/connect.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/connect.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/connect.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/connect.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-header.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-header.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-header.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-header.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-push.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-push.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-push.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-push.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-request.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-request.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-request.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-request.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-response.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-response.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how-to-parse-response.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how-to-parse-response.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how_to_handshake.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how_to_handshake.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/how_to_handshake.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/how_to_handshake.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/protocol_overview.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/protocol_overview.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/protocol/protocol_overview.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/protocol/protocol_overview.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/socket-otp-api.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/socket-otp-api.md similarity index 100% rename from i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/socket-otp-api.md rename to i18n/zh-HK/docusaurus-plugin-content-docs/current/api-reference/socket/socket-otp-api.md diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/_category_.json b/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/_category_.json deleted file mode 100644 index 0d91b648..00000000 --- a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-developed/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "position": 2, - "label": "準備開發", - "collapsible": true, - "collapsed": false, - "link": null -} diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-started.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-started.md index f89f243a..6e7f997d 100644 --- a/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-started.md +++ b/i18n/zh-HK/docusaurus-plugin-content-docs/current/getting-started.md @@ -963,12 +963,10 @@ SDK 的詳細 API 文檔請訪問： -- GitHub Issues: +## 回饋及溝通 -- 微信溝通羣（已滿）： - - - -- 飛書溝通羣： - - +| 頻道 | 二維碼 / 連結 | +| -------------------- | ---------------------------------------------------------------------------------------------- | +| GitHub Issues | | +| 微信溝通群（已完成） | | +| 飛書溝通群 | | diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/quote/_category_.json b/i18n/zh-HK/docusaurus-plugin-content-docs/current/quote/_category_.json index ecee0631..4a190eb5 100644 --- a/i18n/zh-HK/docusaurus-plugin-content-docs/current/quote/_category_.json +++ b/i18n/zh-HK/docusaurus-plugin-content-docs/current/quote/_category_.json @@ -1,7 +1,7 @@ { "label": "行情", "collapsible": true, - "collapsed": true, + "collapsed": false, "link": null, "position": 3 } diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/overview.md b/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/overview.md deleted file mode 100644 index c6fe05b4..00000000 --- a/i18n/zh-HK/docusaurus-plugin-content-docs/current/socket/overview.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Overview -id: overview -slug: /socket/overview -sidebar_position: -1 ---- - -我們的 OpenAPI 提供 WebSocket 方式連接行情網關，客戶端可以透過這兩種方式訂閱行情。本章節文檔將會介紹詳細的協定細節。 - -:::success NOTE -我們的 OpenAPI SDK 已經完整實現了訂閱行情的功能，你可以直接使用 SDK。 - -https://open.longportapp.com/sdk - -本章節文檔提供給大家參考 API 細節。 -::: diff --git a/i18n/zh-HK/docusaurus-plugin-content-docs/current/trade/_category_.json b/i18n/zh-HK/docusaurus-plugin-content-docs/current/trade/_category_.json index eb53f382..0cf4aee6 100644 --- a/i18n/zh-HK/docusaurus-plugin-content-docs/current/trade/_category_.json +++ b/i18n/zh-HK/docusaurus-plugin-content-docs/current/trade/_category_.json @@ -1,7 +1,7 @@ { "label": "交易", "collapsible": true, - "collapsed": true, + "collapsed": false, "position": 4, "link": null }