@sansenjian/qq-music-api 1.0.6 → 2.0.0

package/README.md

@@ -1,177 +1,218 @@
-<h1 align="center">QQ Music API</h1>
-
-<div align="center">
-
-<img src='music.png' />
-
-![GitHub watchers](https://img.shields.io/github/watchers/rain120/qq-music-api?style=social) ![GitHub stars](https://img.shields.io/github/stars/rain120/qq-music-api?style=social) ![GitHub forks](https://img.shields.io/github/forks/rain120/qq-music-api?style=social)
-<br />
-![node](https://img.shields.io/node/v/koa?style=flat-square)
-<br />
-![GitHub repo size](https://img.shields.io/github/repo-size/rain120/qq-music-api?style=flat-square) ![GitHub package.json version](https://img.shields.io/github/package-json/v/rain120/qq-music-api?style=flat-square) ![GitHub](https://img.shields.io/github/license/rain120/qq-music-api?style=flat-square) ![GitHub open issues](https://img.shields.io/github/issues/rain120/qq-music-api?style=flat-square) ![GitHub closed issues](https://img.shields.io/github/issues-closed/rain120/qq-music-api) ![GitHub last commit](https://img.shields.io/github/last-commit/rain120/qq-music-api?style=flat-square) ![GitHub top language](https://img.shields.io/github/languages/top/rain120/qq-music-api?style=flat-square)
-
-</div>
-
-> QQ音乐API koa2 版本, 通过Web网页版请求QQ音乐接口数据, 有问题请提 [issue](https://github.com/Rain120/qq-music-api/issues)
-
-> 当前代码仅供学习，不可做商业用途
-
-### API结构图
-
-> 目前暂时没有时间做登录模块的接口，欢迎各位大佬给我`PR`, 阿里嘎多
-
-![qq-music](./screenshot/qq-music.png)
-
-### 环境要求
-
-> 因为本项目采用的是`koa2`, 所以请确保你的`node`版本是7.6.0+
-
-```
-node -v
-```
-### 📦 安装
-
-```
-git clone git@github.com:Rain120/qq-music-api.git
-cd qq-music-api
-npm install
-```
-
-### 🔨项目启动
-```
-// npm i -g nodemon
-npm run start
-
-// or don't install nodemon
-node app.js
-```
-项目监听端口是`3200`
-
-### 🐳 Docker
-
-```sh
-# local local build
-npm run build:local-images
-
-# local remote build
-npm run build:remote-images
-
-# build images
-npm run build:images
-
-# local run
-npm run run:images
-
-# remote run
-docker pull qq-music-api
-```
-
-### 功能特性
-
-- [x] 获取歌曲播放链接 **2021-01-24**
-
-- [x] 支持自定义设置 `cookie` **2021-01-23**
-
-- [x] 获取歌曲 + 专辑图片 **2020-05-24**
-
-- [x] 获取歌手热门歌曲 **2020-07-04**
-
-- [x] 获取QQ音乐产品的下载地址
-
-- [x] 获取歌单分类
-
-- [x] 获取歌单列表
-
-- [x] 获取歌单详情
-
-- [x] 获取MV标签
-
-- [x] 获取MV播放信息
-
-- [x] 获取歌手MV
-
-- [x] 获取相似歌手
-
-- [x] 获取歌手信息
-
-- [x] 获取歌手被关注数量信息
-
-- [x] 获取电台列表
-
-- [x] 获取专辑
-
-- [x] 获取数字专辑
-
-- [x] 获取歌曲歌词
-
-- [x] 获取MV
-
-- [x] 获取新碟信息
-
-- [x] 获取歌手专辑
-
-- [x] ~~获取歌曲VKey~~ **2021-01-24**
-
-- [x] 获取搜索热词
-
-- [x] 获取关键字搜索提示
-
-- [x] 获取搜索结果
-
-- [x] 获取首页推荐
-
-- [x] 获取排行榜单列表
-
-- [x] 获取排行榜单详情
-
-- [x] 获取评论信息(cmd代表的意思没太弄明白)
-
-- [x] 获取票务信息
-
-- [x] 获取歌单详情
-
-- [x] 获取歌手列表
-
-### 使用文档
-
-使用`apis`详见[文档](https://rain120.github.io/qq-music-api/#/)
-
-### 关于项目
-
-**灵感来自**
-
-[Binaryify/NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi)
-
-[Vue2.0开发企业级移动端音乐Web App](https://coding.imooc.com/class/107.html)
-
-**参考内容**
-
-[Koa 2](https://koa.bootcss.com/)
-
-[Axios](https://github.com/axios/axios)
-
-[阮一峰老师 - HTTP Referer 教程](http://www.ruanyifeng.com/blog/2019/06/http-referer.html)
-
-### 项目不足
-
-1. 因为本人没写过`unit test`, 所以本项目尚未添加`unit test`, 等有时间再添加;
-
-2. 登录获取个人信息等接口都没做
-
-#### 🤝 贡献 ![PR](https://img.shields.io/badge/PRs-Welcome-orange?style=flat-square&logo=appveyor)
-
-We welcome all contributions. You can submit any ideas as [pull requests](https://github.com/Rain120/qq-music-api/pulls) or as a GitHub [issue](https://github.com/Rain120/qq-music-api/issues). 
-
-#### 👨‍🏭 作者
-
-> Front-End development engineer, technology stack: React + Typescript + Mobx, also used Vue + Vuex for a while
-
-- [Github](https://github.com/Rain120)
-- [知乎](https://www.zhihu.com/people/yan-yang-nian-hua-120/activities)
-- [掘金](https://juejin.im/user/57c616496be3ff00584f54db)
-
-#### 📝 License
-
-[MIT](https://github.com/Rain120/qq-music-api/blob/master/LICENSE)
-
-Copyright © 2019-present [Rain120](https://github.com/Rain120).
+<h1 align="center">QQ Music API</h1>
+
+<div align="center">
+
+<img src='music.png' />
+
+![GitHub watchers](https://img.shields.io/github/watchers/sansenjian/qq-music-api?style=social) ![GitHub stars](https://img.shields.io/github/stars/sansenjian/qq-music-api?style=social) ![GitHub forks](https://img.shields.io/github/forks/sansenjian/qq-music-api?style=social)
+<br />
+![node](https://img.shields.io/badge/node-%3E%3D18.0.0-green?style=flat-square)
+<br />
+![GitHub repo size](https://img.shields.io/github/repo-size/sansenjian/qq-music-api?style=flat-square) ![GitHub package.json version](https://img.shields.io/github/package-json/v/sansenjian/qq-music-api?style=flat-square) ![GitHub](https://img.shields.io/github/license/sansenjian/qq-music-api?style=flat-square) ![GitHub open issues](https://img.shields.io/github/issues/sansenjian/qq-music-api?style=flat-square) ![GitHub closed issues](https://img.shields.io/github/issues-closed/sansenjian/qq-music-api) ![GitHub last commit](https://img.shields.io/github/last-commit/sansenjian/qq-music-api?style=flat-square) ![GitHub top language](https://img.shields.io/github/languages/top/sansenjian/qq-music-api?style=flat-square)
+
+</div>
+
+> 🍴 本项目 Fork 自 [Rain120/qq-music-api](https://github.com/Rain120/qq-music-api)，原项目已停止维护，此版本持续更新中
+
+> QQ音乐API koa2 版本, 通过Web网页版请求QQ音乐接口数据, 有问题请提 [issue](https://github.com/sansenjian/qq-music-api/issues)
+
+> 当前代码仅供学习，不可做商业用途
+
+### API结构图
+
+> 目前暂时没有时间做登录模块的接口，欢迎各位大佬给我`PR`, 阿里嘎多
+
+![qq-music](./screenshot/qq-music.png)
+
+### 环境要求
+
+> 本项目采用 `koa2`，需要 Node.js 18.0.0+
+
+```
+node -v
+```
+
+### 📦 安装
+
+**方式一：克隆仓库**
+```
+git clone git@github.com:sansenjian/qq-music-api.git
+cd qq-music-api
+npm install
+```
+
+**方式二：NPM 安装**
+```
+npm install @sansenjian/qq-music-api
+```
+
+在项目中使用：
+```javascript
+// 启动 API 服务
+const { spawn } = require('child_process');
+const path = require('path');
+
+const qqMusicPath = path.join(__dirname, 'node_modules', '@sansenjian/qq-music-api', 'app.js');
+spawn('node', [qqMusicPath], { 
+  env: { ...process.env, PORT: '3200' },
+  stdio: 'inherit'
+});
+```
+
+### 🔨 项目启动
+```
+// npm i -g nodemon
+npm run start
+
+// or don't install nodemon
+node app.js
+```
+项目监听端口是 `3200`
+
+### 📋 依赖更新 (2026-03)
+
+本项目已完成依赖现代化升级，主要变更如下：
+
+**生产依赖**
+| 依赖 | 版本 | 说明 |
+|-----|------|-----|
+| axios | ^1.6.0 | 修复安全漏洞 CVE-2021-3749 |
+| koa | ^2.15.0 | 框架更新 |
+| koa-bodyparser | ^4.4.0 | 解析器更新 |
+| @koa/router | ^12.0.0 | 替代 koa-router |
+| koa-static | ^5.0.0 | 静态文件服务 |
+| dayjs | ^1.11.10 | 替代 moment.js (更轻量) |
+
+**开发依赖**
+| 依赖 | 版本 | 说明 |
+|-----|------|-----|
+| eslint | ^8.56.0 | 代码检查 |
+| eslint-config-standard | ^17.0.0 | 标准配置 |
+| prettier | ^3.0.0 | 代码格式化 |
+| husky | ^9.0.0 | Git 钩子 |
+| lint-staged | ^15.0.0 | 暂存区检查 |
+| @commitlint/* | ^18.0.0 | 提交信息规范 |
+| @babel/* | ^7.23.0 | 编译工具 |
+| nodemon | ^3.0.0 | 开发热重载 |
+
+**已移除的依赖**
+- `colors` - 存在安全问题，已用 chalk 替代
+- `moment` - 已用 dayjs 替代
+- `lodash.get` - 已用原生可选链 `?.` 替代
+- `eslint-plugin-node` - 已用 eslint-plugin-n 替代
+- `eslint-plugin-standard` - 已集成到 eslint-config-standard
+
+### 功能特性
+
+- [x] 获取歌曲播放链接 **2021-01-24**
+
+- [x] 支持自定义设置 `cookie` **2021-01-23**
+
+- [x] 获取歌曲 + 专辑图片 **2020-05-24**
+
+- [x] 获取歌手热门歌曲 **2020-07-04**
+
+- [x] 获取QQ音乐产品的下载地址
+
+- [x] 获取歌单分类
+
+- [x] 获取歌单列表
+
+- [x] 获取歌单详情
+
+- [x] 获取MV标签
+
+- [x] 获取MV播放信息
+
+- [x] 获取歌手MV
+
+- [x] 获取相似歌手
+
+- [x] 获取歌手信息
+
+- [x] 获取歌手被关注数量信息
+
+- [x] 获取电台列表
+
+- [x] 获取专辑
+
+- [x] 获取数字专辑
+
+- [x] 获取歌曲歌词
+
+- [x] 获取MV
+
+- [x] 获取新碟信息
+
+- [x] 获取歌手专辑
+
+- [x] ~~获取歌曲VKey~~ **2021-01-24**
+
+- [x] 获取搜索热词
+
+- [x] 获取关键字搜索提示
+
+- [x] 获取搜索结果
+
+- [x] 获取首页推荐
+
+- [x] 获取排行榜单列表
+
+- [x] 获取排行榜单详情
+
+- [x] 获取评论信息(cmd代表的意思没太弄明白)
+
+- [x] 获取票务信息
+
+- [x] 获取歌单详情
+
+- [x] 获取歌手列表
+
+### 使用文档
+
+使用`apis`详见[文档](https://rain120.github.io/qq-music-api/#/)
+
+### 关于项目
+
+**灵感来自**
+
+[Binaryify/NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi)
+
+[Vue2.0开发企业级移动端音乐Web App](https://coding.imooc.com/class/107.html)
+
+**参考内容**
+
+[Koa 2](https://koa.bootcss.com/)
+
+[Axios](https://github.com/axios/axios)
+
+[阮一峰老师 - HTTP Referer 教程](http://www.ruanyifeng.com/blog/2019/06/http-referer.html)
+
+### 项目不足
+
+1. 因为本人没写过`unit test`, 所以本项目尚未添加`unit test`, 等有时间再添加;
+
+2. 登录获取个人信息等接口都没做
+
+#### 🤝 贡献 ![PR](https://img.shields.io/badge/PRs-Welcome-orange?style=flat-square&logo=appveyor)
+
+We welcome all contributions. You can submit any ideas as [pull requests](https://github.com/sansenjian/qq-music-api/pulls) or as a GitHub [issue](https://github.com/sansenjian/qq-music-api/issues). 
+
+#### 👨‍🏭 维护者
+
+- [GitHub](https://github.com/sansenjian)
+
+#### 🙏 原作者
+
+本项目基于 [Rain120](https://github.com/Rain120) 的开源项目，感谢原作者的贡献！
+
+- [GitHub](https://github.com/Rain120)
+- [知乎](https://www.zhihu.com/people/yan-yang-nian-hua-120/activities)
+- [掘金](https://juejin.im/user/57c616496be3ff00584f54db)
+
+#### 📝 License
+
+[MIT](https://github.com/sansenjian/qq-music-api/blob/master/LICENSE)
+
+Copyright © 2019-present [Rain120](https://github.com/Rain120).  
+Fork maintained by [sansenjian](https://github.com/sansenjian).

package/app.js

@@ -1,75 +1,75 @@
-require('@babel/register');
-const Koa = require('koa');
-const app = new Koa();
-const bodyParser = require('koa-bodyparser');
-const path = require('path');
-const static = require('koa-static');
-const exec = require('child_process').exec;
-const chalk = require('chalk');
-
-const cors = require('./middlewares/koa-cors');
-const router = require('./routers/router');
-const cookie = require('./util/cookie');
-require('./util/colors');
-const userInfo = require('./config/user-info');
-const package = require('./package.json');
-global.userInfo = Object.assign({}, userInfo);
-
-console.log(chalk.green('\n🥳🎉 We had supported config the user cookies. \n'));
-
-if (!(global.userInfo.loginUin || global.userInfo.uin)) {
-  console.log(chalk.yellow(`😔 The configuration ${chalk.red('loginUin')} or your ${chalk.red('cookie')} in file ${chalk.green('config/user-info')} has not configured. \n`));
-}
-
-if (!global.userInfo.cookie) {
-  console.log(chalk.yellow(`😔 The configuration ${chalk.red('cookie')} in file ${chalk.green('config/user-info')} has not configured. \n`));
-}
-
-exec('npm info QQ-Music-API version', (err, stdout, stderr) => {
-  if(!err){
-    let version = stdout.trim();
-    if(package.version < version){
-      console.log(`Current Version: ${version}, Current Version: ${package.version}, Please update it.`.prompt);
-    }
-  }
-});
-
-app.use(bodyParser());
-app.use(cookie());
-app.use(static(
-  path.join(__dirname,  'public')
-));
-
-// logger
-app.use(async (ctx, next) => {
-  await next();
-  const rt = ctx.response.get('X-Response-Time');
-  console.log(`${ctx.method} ${ctx.url} - ${rt}`.prompt);
-});
-
-// cors
-app.use(cors({
-  origin: (ctx) => ctx.request.header.origin,
-  exposeHeaders: ['WWW-Authenticate', 'Server-Authorization'],
-  maxAge: 5,
-  credentials: true,
-  allowMethods: ['GET', 'POST', 'DELETE'],
-  allowHeaders: ['Content-Type', 'Authorization', 'Accept'],
-}));
-
-// x-response-time
-app.use(async (ctx, next) => {
-  const start = Date.now();
-  await next();
-  const ms = Date.now() - start;
-  ctx.set('X-Response-Time', `${ms}ms`);
-});
-
-app.use(router.routes())
-  .use(router.allowedMethods());
-
-const PORT = process.env.PORT || 3200;
-
-app.listen(PORT, () => {
-  console.log(`server running @ http://localhost:${PORT}`.prompt);
-});
+require('@babel/register');
+const Koa = require('koa');
+const app = new Koa();
+const bodyParser = require('koa-bodyparser');
+const path = require('path');
+const static = require('koa-static');
+const exec = require('child_process').exec;
+const chalk = require('chalk');
+
+const cors = require('./middlewares/koa-cors');
+const router = require('./routers/router');
+const cookie = require('./util/cookie');
+const colors = require('./util/colors');
+const userInfo = require('./config/user-info');
+const package = require('./package.json');
+global.userInfo = Object.assign({}, userInfo);
+
+console.log(chalk.green('\n🥳🎉 We had supported config the user cookies. \n'));
+
+if (!(global.userInfo.loginUin || global.userInfo.uin)) {
+  console.log(chalk.yellow(`😔 The configuration ${chalk.red('loginUin')} or your ${chalk.red('cookie')} in file ${chalk.green('config/user-info')} has not configured. \n`));
+}
+
+if (!global.userInfo.cookie) {
+  console.log(chalk.yellow(`😔 The configuration ${chalk.red('cookie')} in file ${chalk.green('config/user-info')} has not configured. \n`));
+}
+
+exec('npm info QQ-Music-API version', (err, stdout, stderr) => {
+  if(!err){
+    let version = stdout.trim();
+    if(package.version < version){
+      console.log(colors.prompt(`Current Version: ${version}, Current Version: ${package.version}, Please update it.`));
+    }
+  }
+});
+
+app.use(bodyParser());
+app.use(cookie());
+app.use(static(
+  path.join(__dirname,  'public')
+));
+
+// logger
+app.use(async (ctx, next) => {
+  await next();
+  const rt = ctx.response.get('X-Response-Time');
+  console.log(colors.prompt(`${ctx.method} ${ctx.url} - ${rt}`));
+});
+
+// cors
+app.use(cors({
+  origin: (ctx) => ctx.request.header.origin,
+  exposeHeaders: ['WWW-Authenticate', 'Server-Authorization'],
+  maxAge: 5,
+  credentials: true,
+  allowMethods: ['GET', 'POST', 'DELETE'],
+  allowHeaders: ['Content-Type', 'Authorization', 'Accept'],
+}));
+
+// x-response-time
+app.use(async (ctx, next) => {
+  const start = Date.now();
+  await next();
+  const ms = Date.now() - start;
+  ctx.set('X-Response-Time', `${ms}ms`);
+});
+
+app.use(router.routes())
+  .use(router.allowedMethods());
+
+const PORT = process.env.PORT || 3200;
+
+app.listen(PORT, () => {
+  console.log(colors.prompt(`server running @ http://localhost:${PORT}`));
+});

package/commitlint.config.js

@@ -1,20 +1,20 @@
-/*
- * @Author: Rainy
- * @Date: 2020-07-03 18:47:30
- * @LastEditors: Rainy
- * @LastEditTime: 2020-07-03 18:51:11
- */
-
-module.exports = {
-	extends: ['@commitlint/config-conventional'],
-	rules: {
-		'type-enum': [
-			2,
-			'always',
-			['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'chore', 'revert', 'config'],
-		],
-		'subject-full-stop': [0, 'never'],
-		'subject-case': [0, 'never'],
-		'header-max-length': [0, 'always', 150],
-	},
-};
+/*
+ * @Author: Rainy
+ * @Date: 2020-07-03 18:47:30
+ * @LastEditors: Rainy
+ * @LastEditTime: 2020-07-03 18:51:11
+ */
+
+module.exports = {
+	extends: ['@commitlint/config-conventional'],
+	rules: {
+		'type-enum': [
+			2,
+			'always',
+			['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'chore', 'revert', 'config'],
+		],
+		'subject-full-stop': [0, 'never'],
+		'subject-case': [0, 'never'],
+		'header-max-length': [0, 'always', 150],
+	},
+};