@sansenjian/qq-music-api 1.0.6

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "plugins": ["@babel/plugin-transform-async-to-generator"]
+}

package/.dockerignore

@@ -0,0 +1,5 @@
+node_modules
+
+npm-debug.log
+
+docs/

package/.editorconfig

@@ -0,0 +1,31 @@
+# http://editorconfig.org
+# https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
+
+# 表示是最顶层的配置文件, 发现设为true时, 才会停止查找.editorconfig文件
+root = true
+
+[*]
+# tab space
+indent_style = tab
+
+indent_size = 2
+# 设置换行符, 值为lf, cr, crlf
+end_of_line = lf
+charset = utf-8
+
+# 用一个整数来设置tab缩进的列数。默认是indent_size
+tab_width = indent_size
+
+#是否删除行尾的空格
+trim_trailing_whitespace = true
+
+#是否在文件的最后插入一个空行
+insert_final_newline = true
+
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab

package/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es2020": true
+  },
+  "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaVersion": 11
+  },
+  "rules": {
+    "indent": ["error", 2],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"]
+  }
+}

package/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,24 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### 环境
+
+系统:
+
+nodejs 版本(koa2要求版本是7.6.0+):
+
+### 出现问题
+
+### 重现步骤
+
+### 期待效果
+
+> 重现步骤尽量详细,不能含糊不清
+
+> 如果不是提建议,提 issues 如果不照着模版来将不会优先处理或直接关闭

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.prettierignore

@@ -0,0 +1 @@
+node_modules/

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "bracketSpacing": true,
+  "arrowParens": "avoid"
+}

package/CHANGELOG.md

@@ -0,0 +1,70 @@
+## [1.0.4](https://github.com/Rain120/qq-music-api/compare/v1.0.3...v1.0.4) (2021-01-25)
+
+
+### Bug Fixes
+
+* doc screenshot png path ([fe811e2](https://github.com/Rain120/qq-music-api/commit/fe811e26c0c0a2ed468728b0323866bd27b5a404))
+* music play url quality; docs about cookie, music play; ([#35](https://github.com/Rain120/qq-music-api/issues/35)) ([f0b7923](https://github.com/Rain120/qq-music-api/commit/f0b7923b9feb7e32c44bc9417c2d426148ab3865))
+
+
+
+## [1.0.3](https://github.com/Rain120/qq-music-api/compare/v1.0.1...v1.0.3) (2021-01-24)
+
+
+### Bug Fixes
+
+* doc screenshot png path ([cb8b253](https://github.com/Rain120/qq-music-api/commit/cb8b25358219ca1cc3e973e6f46a3f75bb3b8b29))
+
+
+### Features
+
+* user cookie ([#32](https://github.com/Rain120/qq-music-api/issues/32)) ([5a32dae](https://github.com/Rain120/qq-music-api/commit/5a32daeca351c7b18352f9267db0c173fef9bff6))
+
+
+
+## [1.0.1](https://github.com/Rain120/qq-music-api/compare/v1.0.0...v1.0.1) (2020-12-25)
+
+
+### Bug Fixes
+
+* build docker image sh ([fe395a4](https://github.com/Rain120/qq-music-api/commit/fe395a435efc0678d3d387abbcd6b33786bb72fa))
+
+
+### Features
+
+* docker build images to hub for docker env run ([dcbbf95](https://github.com/Rain120/qq-music-api/commit/dcbbf95e70b305cd2ad4d00a7cc0bd4db5d0f8ab))
+* docker repository version ([d74a425](https://github.com/Rain120/qq-music-api/commit/d74a4251da8c0c2dac2f5e4251e91f288f732d43))
+
+
+
+# [1.0.0](https://github.com/Rain120/qq-music-api/compare/4d79041a5e5712c0c6bc6e6d55045f732636c80f...v1.0.0) (2020-09-15)
+
+
+### Bug Fixes
+
+* bug about search by key https://github.com/Rain120/qq-music-api/issues/28 ([12b7d66](https://github.com/Rain120/qq-music-api/commit/12b7d667c05f92ad61545c5f75a82d878ad3220c))
+* getComment ([#26](https://github.com/Rain120/qq-music-api/issues/26)) ([9e62be5](https://github.com/Rain120/qq-music-api/commit/9e62be539b3b78cdf0eea3e1696d9505ab242756))
+* getSingerHotsong pagination ([#19](https://github.com/Rain120/qq-music-api/issues/19)) ([9bb705a](https://github.com/Rain120/qq-music-api/commit/9bb705a1b6eb4e2577ba20f0a279ccb63112390d))
+* getSingerHotsong pagination ([#22](https://github.com/Rain120/qq-music-api/issues/22)) ([6d6dbf3](https://github.com/Rain120/qq-music-api/commit/6d6dbf36c545269ad7a6138e711e436a90d61e28))
+* issue 14 about getRank topId was invalid ([024096f](https://github.com/Rain120/qq-music-api/commit/024096fa63144391680f1d6ec376929fee697c37))
+* issue 14 about getRank which bug about period change by qq music api ([f13d2b5](https://github.com/Rain120/qq-music-api/commit/f13d2b540d860994600cc2728e4d848df574b2f4))
+* issue: 12 -> (getHotkey -> getHotKey); axios option error; ([ee0371b](https://github.com/Rain120/qq-music-api/commit/ee0371b32352546feb8b60b7725dc3ff66a412ef))
+* issue: 12, require getHotkey Camel-Case bug ([0eb9297](https://github.com/Rain120/qq-music-api/commit/0eb9297ff19773ef2d61377f341937f20a70d6a4))
+* mv params bug: https://github.com/Rain120/qq-music-api/issues/16\#issuecomment-638230301 ([8f29b87](https://github.com/Rain120/qq-music-api/commit/8f29b874705ab0638310bcc13781a5599ab9de4d)), closes [#issuecomment-638230301](https://github.com/Rain120/qq-music-api/issues/issuecomment-638230301)
+* song list params bug: https://github.com/Rain120/qq-music-api/issues/16 ([d9fb973](https://github.com/Rain120/qq-music-api/commit/d9fb9732f546cb76f208053a8dabd164aad893c5))
+
+
+### Features
+
+* add song list ([c0e8de8](https://github.com/Rain120/qq-music-api/commit/c0e8de86dd93a907aa75e838c18d967b1434493d))
+* batch get song info ([0ac4cfc](https://github.com/Rain120/qq-music-api/commit/0ac4cfca38e15e727d79f76c39e729a0ff3abc16))
+* batch get songlist ([facc3cb](https://github.com/Rain120/qq-music-api/commit/facc3cbf7a44fbeb1db48bfa0c18e7918938b21c))
+* eslint + prettier + commitlint + changelog + editorconfig ([e547ca3](https://github.com/Rain120/qq-music-api/commit/e547ca3c43db052769a06f5e0090a29749b721d5))
+* get song info; rebuild the axios request, cut down route params ([4d79041](https://github.com/Rain120/qq-music-api/commit/4d79041a5e5712c0c6bc6e6d55045f732636c80f))
+* getImageUrl; commit push shell; ([69f257a](https://github.com/Rain120/qq-music-api/commit/69f257a41d5d4746dce306c84ff902358a0d391c))
+* rebuild router and axios ([0b737df](https://github.com/Rain120/qq-music-api/commit/0b737df8971a560119af2bcae199a1ea5549859c))
+* rebuild router for lost ([2165b6a](https://github.com/Rain120/qq-music-api/commit/2165b6a8b5527bb2b68592b17e28846fce1e856f))
+* rebuild routers ([1278008](https://github.com/Rain120/qq-music-api/commit/1278008d57bd8fb4bced800c3de6c6f16f0aee8f))
+
+
+

package/Dockerfile

@@ -0,0 +1,18 @@
+FROM node:22
+
+LABEL maintainer="Rain120 <1085131904@qq.com>"
+
+# Create app directory
+WORKDIR /app
+
+COPY package.json .
+
+RUN yarn install --registry=https://registry.npmmirror.com
+
+COPY . .
+
+EXPOSE 3200
+
+ENTRYPOINT ["npm", "run"]
+
+CMD ["start"]

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,177 @@
+<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).

package/app.js

@@ -0,0 +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);
+});

package/commitlint.config.js

@@ -0,0 +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],
+	},
+};

package/config/user-info.js

@@ -0,0 +1,42 @@
+const fs = require('fs')
+const path = require('path')
+
+let userInfo, cookieList, cookieObject;
+const infoPath = path.join(__dirname, './user-info.json');
+fs.existsSync(infoPath) || fs.writeFileSync(infoPath, '{}', 'utf-8');
+
+const initData = () => {
+  
+  userInfo = { loginUin: '', cookie: '', ...JSON.parse(fs.readFileSync(infoPath, 'utf-8')) };
+  cookieList = userInfo.cookie.split('; ').map(_ => _.trim());
+
+  cookieObject = {};
+  cookieList.filter(Boolean).forEach(_ => {
+    if (_) {
+      const [key, value = ''] = _.split('=');
+  
+      cookieObject[key] = value;
+    }
+  });
+};
+
+const refreshData = cookie => {
+  const uin = cookie.match(/ uin=([^;]+)/)[1];
+  fs.writeFileSync(infoPath, JSON.stringify({ loginUin: uin, cookie: cookie }), 'utf-8');
+  initData();
+  return { 
+    ...userInfo, 
+    uin: userInfo.loginUin || cookieObject.uin,
+    cookieList,
+    cookieObject
+  };
+};
+
+initData();
+
+module.exports = Object.assign(userInfo, {
+  uin: userInfo.loginUin || cookieObject.uin,
+  cookieList,
+  cookieObject,
+  refreshData
+});

package/index.js

@@ -0,0 +1 @@
+require('./app.js')