Skip to content

RoyHughluo/listen1-api

 
 

Repository files navigation

listen1-api

listen1音乐资源API库,可运行在 Nodejs 和 浏览器环境(限chrome extension 或 electron)

特性

  • 集成网易,QQ,虾米,酷狗,酷我,Bilibili平台的音乐资源API
  • 支持获取热门歌单,歌手歌单,专辑歌单
  • 支持搜索歌曲
  • 支持获取歌曲歌词信息
  • 支持获取歌曲的播放地址

编译

$ git clone [email protected]:listen1/listen1-api.git
$ cd listen1-api
$ yarn install
$ yarn build

编译后文件在dist目录下,listen1-api.jslisten1-api.min.js

安装

浏览器环境

<script src="listen1-api.min.js"></script>
<script>
  console.log(listen1Api);
</script>

Nodejs环境

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

开始使用 (nodejs 环境)

下载压缩版本,或dist目录下的listen1-api.min.js到本地目录

const listen1Api = require('./listen1-api.min');
const platform = 'netease';
// 获取网易平台的热门歌单列表
const url = '/show_playlist?source='+platform;

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

文档

https://listen1.github.io/listen1-api

项目技术

  • 使用webpack-library-starter模板建立项目。
  • 基于Webpack 4打包。
  • ES6 语法。
  • 导出umd格式的包,支持在浏览器环境和nodejs环境运行。
  • ES6 测试基于 MochaChai
  • 使用ESLint进行语法检查。

开发使用

  1. 编译生成
  • 运行 yarn install (推荐) 或 npm install ,安装依赖包。
  • 运行 yarn buildnpm run build 来生成压缩版本的库文件。
  1. 开发者模式
  • 运行 yarn devnpm run dev 安装依赖包。生成一个非压缩版本的库文件并且在文件变化时自动重新编译。
  1. 运行测试
  • 运行 yarn testnpm run test

常用命令

  • yarn build or npm run build - 在dist目录下编译生成正式版的库文件。
  • yarn dev or npm run dev - 编译生成dev版本的库并实时更新。
  • yarn test or npm run test - 运行测试。
  • yarn test:watch or npm run test:watch - 在watch模式运行测试。

About

One API for all free music in China

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%