@neteasecloudmusicapienhanced/unblockmusic-utils
v0.2.4
Published
⚙️A unlock music tool for NeteaseCloudMusicApiEnhanced.
Readme
⚙️ UnblockNeteaseMusic - Utils
为 NeteaseCloudMusicApiEnhanced 提供的音源匹配工具
项目特点
- 多音源支持 - 内置多个音源模块,自动切换获取最佳链接
- RESTful API - 标准 HTTP 接口,易于集成
- 模块化设计 - 可作为独立服务或 npm 包使用
- 简单部署 - 支持 Vercel 一键部署
📦 安装
克隆项目
git clone https://github.com/NeteaseCloudMusicApiEnhanced/UnblockNeteaseMusic-utils.git
cd UnblockNeteaseMusic-utils
# 安装依赖
pnpm install # 推荐
# 或
npm install直接使用 npx(无需安装)
npx @neteasecloudmusicapienhanced/unblockmusic-utils🚀 快速开始
命令行运行
# 使用默认端口 3000
npm run start
pnpm start
# 指定端口
npx . --port 8080
PORT=8080 npm run start
# 显示帮助信息
npx . --help开发模式
npm run dev # 使用 nodemon 自动重启Vercel 部署
项目已配置 vercel.json,可以直接推送到 Vercel 部署:
vercel deploy📡 API 文档
获取音乐链接
GET /match
curl "http://localhost:3000/match?id=123456"
curl "http://localhost:3000/match?id=123456&source=unm"POST /match
curl -X POST http://localhost:3000/match \
-H "Content-Type: application/json" \
-d '{"id": "123456", "source": "unm"}'请求参数:
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| id | string | ✅ | 网易云音乐歌曲 ID |
| source | string | ❌ | 指定音源模块(不指定则自动选择) |
响应示例:
{
"code": 200,
"data": {
"url": "https://example.com/music.mp3"
}
}内部接口
获取音源列表
GET /inner/modules响应:
{
"code": 200,
"data": {
"modules": ["baka", "gdmusic", "msls", "qijieya", "unm"]
}
}获取版本信息
GET /inner/version响应:
{
"code": 200,
"data": {
"version": "0.2.0"
}
}🔌 作为模块使用
const { matchID } = require('@neteasecloudmusicapienhanced/unblockmusic-utils');
// 匹配歌曲(自动选择音源)
const result = await matchID('123456');
// 指定音源
const result = await matchID('123456', 'unm');
console.log(result);
// { code: 200, data: { url: "..." } }⚙️ 配置
环境变量
| 变量 | 默认值 | 说明 |
|------|--------|------|
| PORT | 3000 | 服务监听端口 |
| NODE_ENV | - | 运行环境(production/development) |
命令行选项
--port, -p <端口号> 指定服务器端口
--help, -h 显示帮助信息📄 许可证
MIT License - 详见 LICENSE 文件
🤝 贡献
欢迎提交 Issue 和 Pull Request!
🔗 相关项目
- NeteaseCloudMusicApiEnhanced - 增强版网易云音乐 API
- UnblockNeteaseMusic - 网易云音乐解锁核心库
Made with ❤️ by NeteaseCloudMusicApiEnhanced
