新增说明

.vitepress/config.mts

@@ -27,14 +27,14 @@ export default defineConfig({
     logo: "/logo.png",
     nav: [
       { text: '首页', link: '/' },
-      { text: '文档', link: '/markdown-examples' }
+      { text: '文档', link: '/shuoming' },
     ],
 
     sidebar: [
       {
-        text: '测试',
+        text: '落月API',
         items: [
-          { text: '测试1', link: '/markdown-examples' },
+          { text: '说明', link: '/shuoming' },
           { text: 'webman', link: '/webman' }
         ]
       }

src/index.md

@@ -11,10 +11,10 @@ hero:
   actions:
     - theme: brand
       text: 快速开始
-      link: /markdown-examples
+      link: /shuoming
     - theme: alt
       text: 官方SDK
-      link: /api-examples
+      link: /webman
 
 features:
   - title: 问题 A

src/shuoming.md

@@ -0,0 +1,47 @@
+
+- ## 前言
+  欢迎使用落月api，当前文档为v2版本，v1版本长时间不维护bug较多所以不再维护。
+  v2版本相对于v1版本进行了一定的优化，主要围绕性能以及功能上的优化，后面会介绍。
+  为了更好的提供api服务，我在2024-06-10正式决定与小杰合作开发。
+  doc前端使用ShowDoc项目（https://github.com/star7th/showdoc)
+  api后端使用webman框架(https://www.workerman.net)
+
+- ## 关于域名
+  [doc.vkeys.cn](https://doc.vkeys.cn "doc.vkeys.cn") 相关接口文档
+  [api.vkeys.cn](https://api.vkeys.cn "api.vkeys.cn") 后端接口域名
+  [api.epdd.cn](https://api.epdd.cn "api.vkeys.cn") 后端接口备用域名，用于测试
+
+- ## API路径及请求规范
+   - 第二版- API：https://{域名}/v2/{接口分类}/{接口功能}
+   - 第一版API（废弃）：https://{域名}/v1/{接口分类}/{接口功能}
+  请求方式`GET`和`POST`任意即可
+
+- ## 文档路径规范
+   `接口分类` -> `数据提供商` -> `接口名称（包含多级目录）`
+
+- ## 新特性
+  - 使用了连接池、请求合并等技术，具有更高效的请求速度。
+  - 使用了redis缓存、消息队列等技术，实现高并发环境下正常使用。
+  - 使用了跨域技术，允许不同域名的情况下访问我站API。
+  - 使用验证器，在进行接口提交时，API会验证参数是否合法。
+  - 使用错误处理和日志处理，在程序出现异常时，系统自动中断执行并保存相关信息，以便修复bug。
+
+- ## 后续开发计划
+  1. 开发后台管理（学完vue3之后）
+  2. 开发QQ音乐相关具体功能（如搜索模块新增搜索歌手、搜索歌词、搜索专辑、搜索歌单等）
+  3. 开发网易云音乐相关功能
+  4. 开发酷狗音乐相关功能
+  5. 开发网站工具类相关功能
+
+- ##  联系方式
+ 落月：`[email protected]`
+ 小杰：`[email protected]`
+ QQ群：`暂无`
+
+- ## 关于服务器
+ 数据缓存时间：`5分钟 ~ 1天`（5分钟内重复请求延长缓存时间，最长不超过1天）
+ QPS限制：`暂无`
+
+
+- ##  整站调用量（待实现）
+https://api.vkeys.cn/Call