From 90b9883691f082126ccbeaaa39e452bb6601baf1 Mon Sep 17 00:00:00 2001 From: overwriter <9856mmm@gmail.com> Date: Sun, 12 Jan 2025 12:48:04 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E8=A1=A5=E5=85=85=E6=AD=8C=E8=AF=8D?= =?UTF-8?q?=E6=91=98=E5=BD=95=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.MD | 4 +++ public/docs/home.md | 68 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+) diff --git a/README.MD b/README.MD index 4acf1b6..d77306c 100644 --- a/README.MD +++ b/README.MD @@ -449,6 +449,10 @@ banner({ type: 0 }).then((res) => { 303. 歌单导入 - 任务状态 304. 副歌时间 305. 相关歌单推荐 +306. 歌词摘录 - 歌词摘录信息 +307. 歌词摘录 - 我的歌词本 +308. 歌词摘录 - 添加/修改摘录歌词 +309. 歌词摘录 - 删除摘录歌词 ## 单元测试 diff --git a/public/docs/home.md b/public/docs/home.md index f95cd08..bc7cee9 100644 --- a/public/docs/home.md +++ b/public/docs/home.md @@ -321,6 +321,10 @@ 303. 歌单导入 - 任务状态 304. 副歌时间 305. 相关歌单推荐 +306. 歌词摘录 - 歌词摘录信息 +307. 歌词摘录 - 我的歌词本 +308. 歌词摘录 - 添加/修改摘录歌词 +309. 歌词摘录 - 删除摘录歌词 ## 安装 @@ -5018,6 +5022,70 @@ let link = encodeURIComponent( **调用例子:** `/playlist/detail/rcmd/get?id=8039587836` +### 歌词摘录 - 歌词摘录信息 + +说明: 登录后调用此接口, 传入歌曲id, 获取歌词摘录信息 + +**必选参数:** + +`id`: 歌曲id + +**接口地址:** `/song/lyrics/mark` + +**调用例子:** `/song/lyrics/mark?id=2058263032` + +### 歌词摘录 - 我的歌词本 + +说明: 登录后调用此接口, 获取我的歌词本 + +**可选参数 :** + +`limit` : 返回数量 , 默认为 20 + +`offset` : 偏移数量,用于分页 ,如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0 + +**接口地址:** `/song/lyrics/mark/user/page` + +**调用例子:** `/song/lyrics/mark/user/page` + +### 歌词摘录 - 添加/修改摘录歌词 + +说明: 登录后调用此接口, 传入歌曲id, 可以添加/修改摘录歌词 + +**必选参数:** + +`id`: 歌曲id + +`data`: 存储歌词摘录信息的对象数组的字符串,如: +```javascript +let data = encodeURIComponent( + JSON.stringify([ + { + "translateType": 1, + "startTimeStamp": 800, + "translateLyricsText": "让我逃走吧、声音已经枯萎", + "originalLyricsText": "逃がし てくれって声を枯らした" + } +]), +) +``` + +若需要修改摘录信息, 则需要填入参数```markId```, 修改对应的摘录信息 + +**接口地址:** `/song/lyrics/mark/add` + +### 歌词摘录 - 删除摘录歌词 + +说明: 登录后调用此接口, 传入摘录歌词id, 删除摘录歌词 + +**必选参数:** + +`id`: 摘录歌词id + +**接口地址:** `/song/lyrics/mark/del` + +**调用例子:** `/song/lyrics/mark?id=2083850` + ## 离线访问此文档 此文档同时也是 Progressive Web Apps(PWA), 加入了 serviceWorker, 可离线访问