Listen1 API：一站式中国免费音乐统一接口

项目简介

Listen1 API 是一个面向开发者的音乐资源接口库，它整合了中国主流音乐平台的免费音乐资源，提供了统一的API访问方式。该项目基于JavaScript开发，支持Node.js环境和浏览器环境运行，让开发者能够轻松获取和处理来自多个音乐平台的数据。

核心特性

Listen1 API 提供了丰富的音乐资源访问功能：

• 多平台集成：支持网易云音乐、QQ音乐、虾米音乐、酷狗音乐、酷我音乐、Bilibili音乐六大平台
• 热门歌单获取：可获取各平台的热门歌单列表和详情
• 智能搜索功能：支持跨平台音乐搜索，返回结构化数据
• 歌词信息获取：提供歌曲歌词信息的标准化访问
• 播放地址解析：获取歌曲的实际播放地址
• 跨平台兼容：支持Node.js和浏览器环境运行

技术架构

该项目采用现代化的JavaScript技术栈：

• Webpack 4 作为模块打包工具
• ES6语法 编写源代码
• UMD格式 输出，确保跨环境兼容性
• Mocha和Chai 用于单元测试
• ESLint 进行代码质量检查

快速开始

安装部署

git clone https://gitcode.com/gh_mirrors/li/listen1-api
cd listen1-api
yarn install
yarn build

编译完成后，在dist目录下会生成 listen1-api.js 和 listen1-api.min.js 两个文件。

基础使用示例

在Node.js环境中使用：

const listen1Api = require('./listen1-api.min');

// 获取网易云音乐热门歌单
const platform = 'netease';
const url = '/show_playlist?source=' + platform;

listen1Api.apiGet(url).then((data) => {
  console.log(data);
});

在浏览器环境中使用：

<script src="listen1-api.min.js"></script>
<script>
  // 直接使用全局对象 listen1Api
  const url = '/show_playlist?source=qq';
  listen1Api.apiGet(url).then(console.log);
</script>

API接口详解

主要端点

1. /show_playlist - 获取平台热门歌单列表

   • 参数：source（平台名称）、offset（偏移量）
   • 返回：歌单数组

2. /get_playlist - 获取歌单详情

   • 参数：list_id（歌单ID）
   • 返回：歌单信息和歌曲列表

3. /search - 搜索歌曲

   • 参数：source（平台名称）、keywords（关键词）、curpage（页码）
   • 返回：搜索结果总数和歌曲数组

4. /lyric - 获取歌词信息

   • 参数：track_id（歌曲ID）
   • 返回：LRC格式歌词

5. /bootstrap_track - 获取播放地址

   • 参数：track_id（歌曲ID）
   • 返回：歌曲播放URL

数据结构

歌单对象(Playlist) 包含以下字段：

• id：歌单唯一标识符
• cover_img_url：封面图片URL
• title：歌单标题
• source_url：来源网页URL

歌曲对象(Track) 包含以下字段：

• id：歌曲唯一标识符
• title：歌曲标题
• artist：歌手名称
• album：专辑名称
• source：来源平台
• img_url：封面图片URL

开发指南

环境配置

项目支持开发者模式和测试模式：

# 开发模式（实时编译）
yarn dev

# 运行测试
yarn test

# 监听模式运行测试
yarn test:watch

自定义适配

Listen1 API 提供了灵活的适配接口，允许开发者自定义：

• HTTP请求实现：可传入自定义的HTTP客户端
• Promise实现：支持不同的Promise库
• Cookie管理：可自定义Cookie处理逻辑

应用场景

Listen1 API 可广泛应用于：

• 音乐播放器开发：构建跨平台音乐播放应用
• 音乐推荐系统：基于多平台数据的智能推荐
• 音乐数据分析：收集和分析各平台音乐流行趋势
• 教学演示：学习API设计和JavaScript模块化开发

项目优势

1. 统一接口：将多个音乐平台的API统一为标准接口
2. 开箱即用：简单的安装配置即可开始使用
3. 文档完善：提供详细的使用文档和示例代码
4. 持续维护：项目在GitHub上活跃更新
5. 社区支持：拥有活跃的开发者社区

通过Listen1 API，开发者可以专注于业务逻辑的实现，而无需关心各个音乐平台API的差异和复杂性，大大提高了开发效率和项目的可维护性。