diff --git a/docs/README.md b/docs/README.md index a039c17989c9f7e0c554639090e45fa0f7eed7be..02d7858eb75f39c056438dc3ec3a19a68d7f9ac5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -109,39 +109,25 @@ ```shell $ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git - - $ npm install - - - ``` ## 运行 ```shell $ node app.js - - - ``` 服务器启动默认端口为 3000, 若不想使用 3000 端口 , 可使用以下命令 : Mac/Linux ```shell $ PORT=4000 node app.js - - - ``` windows 下使用 git-bash 或者 cmder 等终端执行以下命令 : ```shell $ set PORT=4000 && node app.js - - - ``` ## 可以使用代理 @@ -179,24 +165,11 @@ request 相关的环境变量 ```shell docker pull twesix/netease-cloud-music - - docker run -d -p 3000:3000 --name netease-cloud-music twesix/netease-music-api - - - - - - // 去掉或者设置相关的环境变量 - - docker run -d -p 3000:3000 --name netease-cloud-music -e http_proxy= -e https_proxy= -e no_proxy= -e HTTP_PROXY= -e HTTPS_PROXY= -e NO_PROXY= netease-cloud-music - - - ``` > 由于 docker 镜像更新不是很及时,推荐自己 build, 以下为 build 镜像的方式 @@ -204,16 +177,9 @@ docker run -d -p 3000:3000 --name netease-cloud-music -e http_proxy= -e https_pr ``` $ git clone https://github.com/Binaryify/NeteaseCloudMusicApi && cd NeteaseCloudMusicApi - - $ sudo docker build . -t netease-music-api - - $ sudo docker run -d -p 3000:3000 netease-music-api - - - ``` ## 接口文档 @@ -321,28 +287,15 @@ Cookies ``` gender: 性别 0:保密 1:男性 2:女性 - - birthday: 出生日期,时间戳 unix timestamp - - nickname: 用户昵称 - - province: 省份id - - city: 城市id - - signature：用户签名 - - - ``` **接口地址 :** `/user/subcount` @@ -370,20 +323,11 @@ signature：用户签名 ``` id:歌单id - - -name:歌单名字 - - +name:歌单名字= desc:歌单描述 - - tags:歌单tag - - - ``` **接口地址 :** `/playlist/update` @@ -526,68 +470,35 @@ category Code 取值: ``` 入驻歌手 5001 - - 华语男歌手 1001 - - 华语女歌手 1002 - - 华语组合/乐队 1003 - - 欧美男歌手 2001 - - 欧美女歌手 2002 - - 欧美组合/乐队 2003 - - 日本男歌手 6001 - - 日本女歌手 6002 - - 日本组合/乐队 6003 - - 韩国男歌手 7001 - - 韩国女歌手 7002 - - 韩国组合/乐队 7003 - - 其他男歌手 4001 - - 其他女歌手 4002 - - 其他组合/乐队 4003 - - - ``` **接口地址 :** `/artist/list` @@ -886,24 +797,13 @@ mp3url 不能直接用 , 可通过 `/song/url` 接口传入歌曲 id 获取具 ``` 全部:0 - - 华语:7 - - 欧美:96 - - 日本:8 - - 韩国:16 - - - ``` `limit`: 取出数量 , 默认为 100 @@ -1020,28 +920,15 @@ mp3url 不能直接用 , 可通过 `/song/url` 接口传入歌曲 id 获取具 ``` 0: 歌曲 - - 1: mv - - 2: 歌单 - - 3: 专辑 - - 4: 电台 - - 5: 视频 - - - ``` **接口地址 :** `/comment/hot` @@ -1064,28 +951,15 @@ mp3url 不能直接用 , 可通过 `/song/url` 接口传入歌曲 id 获取具 ``` 0: 歌曲 - - 1: mv - - 2: 歌单 - - 3: 专辑 - - 4: 电台 - - 5: 视频 - - - ``` **接口地址 :** `comment/like` @@ -1109,28 +983,15 @@ mp3url 不能直接用 , 可通过 `/song/url` 接口传入歌曲 id 获取具 ``` 0: 歌曲 - - 1: mv - - 2: 歌单 - - 3: 专辑 - - 4: 电台 - - 5: 视频 - - - ``` `id`:对应资源 id @@ -1150,34 +1011,24 @@ mp3url 不能直接用 , 可通过 `/song/url` 接口传入歌曲 id 获取具 ``` 0: 歌曲 - - 1: mv - - 2: 歌单 - - 3: 专辑 - - 4: 电台 - 5: 视频 - - - ``` `id`:对应资源 id `content` :内容 id,可通过 `/comment/mv` 等接口获取 **调用例子** : `/comment?t=0&type=1&id=5436712&commentId=1535550516319` (在广岛之恋 mv 删除评论) + ``` + ### banner @@ -1198,16 +1049,9 @@ mp3url 不能直接用 , 可通过 `/song/url` 接口传入歌曲 id 获取具 ``` 1: mv - - 4: 电台 - - 5: 视频 - - - ``` `t`: 操作,1 为点赞,其他未取消点赞 @@ -1620,100 +1464,51 @@ MV 数据 , 数据包含 mv 名字 , 歌手 , 发布时间 , mv 视频地址等 ``` "0": 云音乐新歌榜, - - "1": 云音乐热歌榜, - - "2": 网易原创歌曲榜, - - "3": 云音乐飙升榜, - - "4": 云音乐电音榜, - - "5": UK排行榜周榜, - - "6": 美国Billboard周榜 - - "7": KTV嗨榜, - - "8": iTunes榜, - - "9": Hit FM Top榜, - - "10": 日本Oricon周榜 - - "11": 韩国Melon排行榜周榜, - - "12": 韩国Mnet排行榜周榜, - - "13": 韩国Melon原声周榜, - - "14": 中国TOP排行榜(港台榜), - - "15": 中国TOP排行榜(内地榜) - - "16": 香港电台中文歌曲龙虎榜, - - "17": 华语金曲榜, - - "18": 中国嘻哈榜, - - "19": 法国 NRJ EuroHot 30周榜, - - "20": 台湾Hito排行榜, - - "21": Beatport全球电子舞曲榜, - - "22": 云音乐ACG音乐榜, - - "23": 云音乐嘻哈榜 - - - ``` **接口地址 :** `/top/list`