add album api & unit test, improve document

2026-10-22 07:31:23 +08:00 · 2017-04-05 09:50:28 +08:00
parent f6b9ff2441
commit 6630fa1e14
9 changed files with 67 additions and 9 deletions
@@ -4,7 +4,7 @@


 ## 版本新特性  
-2017/4/1 升级到 2.0 版本.增加使用文档,完成项目重构,增加更完善的单元测试,版本升级到2.0,升级 api 到 v2+,支持登录并获取用户信息和创建的歌单,可通过获取音乐 url 接口获取用户歌单里的的音乐,获取每日推荐歌单和每日推荐音乐
+升级到 2.0 版本.增加使用文档,完成项目重构,增加更完善的单元测试,版本升级到2.0,升级 api 到 v2+,支持登录并获取用户信息和创建的歌单,可通过获取音乐 url 接口获取用户歌单里的的音乐,获取每日推荐歌单和每日推荐音乐

 ## 安装  
 ``` shell
@@ -69,6 +69,19 @@ $ node app.js

 ### 搜索音乐
 说明:调用此接口,传入搜索关键词可以搜索该音乐,关键词可以多个,以空格隔开,如"周杰伦 搁浅"(不需要登录)  
+必选参数:
+keywords : 关键词
+可选参数:
+limit: 返回数量  
+type: 搜索类型；取值意义  
+. 1 单曲  
+. 10 专辑  
+. 100 歌手  
+. 1000 歌单  
+. 1002 用户  
+ 
+ offset: 偏移数量，用于分页  
+
 接口地址:  
 `/search`  
 调用例子:  
@@ -85,6 +98,17 @@ $ node app.js
 返回数据如下图: 
 ![搜索音乐](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E6%AD%8C%E8%AF%8D.png)

+### 获取歌手专辑列表
+说明:调用此接口,传入歌手 id,可获得歌手专辑列表  
+接口地址:  
+`/album`  
+调用例子:  
+`album?id=32311`  
+![获取专辑](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E4%B8%93%E8%BE%91.png)
+
+
+
+
 ### 获取每日推荐歌单
 说明:调用此接口,可获得每日推荐歌单(需要登录)
 接口地址: