yms-netease-music-api

基于原NeteaseCloudMusicApi，专供yms特别版接口，第三方调用依赖需注意该版本接口非通用，调用可能被异常风控

项目简介

yms-netease-music-api是一个基于Node.js的第三方音乐平台API服务，专门为YourMusicStation(YMS)点歌台软件提供后端接口支持。本项目作为YMS软件的核心组件，提供了完整的音乐平台功能接口，包括用户认证、音乐搜索、播放列表管理、云盘存储等核心功能。

技术架构

后端技术栈

• 运行环境：Node.js >= 16
• Web框架：Express.js
• HTTP客户端：Axios
• 文件上传：express-fileupload
• 音频处理：music-metadata
• 加密解密：crypto-js、node-forge
• 二维码生成：qrcode

部署方案

• 本地部署：支持Windows、Linux、macOS
• 云服务部署：Vercel、腾讯云Serverless等
• 容器化：Docker镜像支持
• 可执行文件：pkg打包的独立可执行程序

快速开始

环境要求

Node.js >= 16
npm | pnpm | yarn

安装步骤

# 克隆项目
git clone https://github.com/kikolove/yms-netease-music-api.git

# 进入项目目录
cd yms-netease-music-api

# 安装依赖
pnpm install

# 启动开发服务器
pnpm run dev

使用示例

const ymsApi = require('yms-netease-music-api');

// 搜索音乐
ymsApi.search({
  keywords: '周杰伦',
  type: 1,
  limit: 30
}).then(result => {
  console.log(result);
});

// 用户登录
ymsApi.login_cellphone({
  phone: '13800138000',
  password: 'your_password'
}).then(result => {
  console.log(result);
});

API文档

详细的API接口文档请访问：API文档

主要功能模块：

• 用户认证系统
• 音乐搜索系统
• 播放列表管理
• 云盘服务
• 协作听歌

部署指南

本地部署

# 生产环境启动
node app.js

# 指定端口
PORT=3001 node app.js

云平台部署

• Vercel部署：参考部署文档
• 腾讯云Serverless：参考腾讯云部署

Docker部署

FROM node:16-alpine
WORKDIR /app
COPY . .
RUN npm install --production
EXPOSE 3000
CMD ["node", "app.js"]

项目结构

yms-netease-music-api/
├── module/           # API模块目录
│   ├── login.js      # 登录相关接口
│   ├── search.js     # 搜索相关接口
│   └── ...           # 其他功能模块
├── public/           # 静态资源和演示页面
│   ├── docs/         # API文档
│   └── audio_match_demo/  # 音频识别演示
├── util/             # 工具函数
├── plugins/          # 插件系统
├── server.js         # 服务器主文件
├── app.js            # 应用入口
└── main.js           # 主模块导出

注意事项

⚠️ 重要提醒：

• 请遵守相关音乐平台的使用条款
• 第三方调用可能存在风控风险
• 请勿用于商业用途

许可证

本项目采用MIT许可证，详情请查看LICENSE文件。

相关链接

• YMS官网
• API文档