README.MD 2.1 KB
Newer Older
1
# NeteaseCloudMusicApi
zhuangtongfa's avatar
zhuangtongfa 已提交
2
一个调用网易云音乐 API 的 node 模块
zhuangtongfa's avatar
zhuangtongfa 已提交
3
<p>
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
4
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/npm/v/NeteaseCloudMusicApi.svg" alt="Version"></a>
zhuangtongfa's avatar
zhuangtongfa 已提交
5
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/npm/l/NeteaseCloudMusicApi.svg" alt="License"></a>
zhuangtongfa's avatar
zhuangtongfa 已提交
6 7
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/david/dev/binaryify/NeteaseCloudMusicApi.svg" alt="devDependencies" ></a>
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/david/binaryify/NeteaseCloudMusicApi.svg" alt="devDependencies" ></a>
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
8
<a href="https://codeclimate.com/github/Binaryify/NeteaseCloudMusicApi"><img src="https://codeclimate.com/github/Binaryify/NeteaseCloudMusicApi/badges/gpa.svg" /></a>
zhuangtongfa's avatar
zhuangtongfa 已提交
9
<a href="https://travis-ci.org/Binaryify/NeteaseCloudMusicApi"><img src="https://api.travis-ci.org/Binaryify/NeteaseCloudMusicApi.svg?branch=master" /></a>
zhuangtongfa's avatar
zhuangtongfa 已提交
10 11
</p>  

zhuangtongfa's avatar
update  
zhuangtongfa 已提交
12
![](http://binaryify.github.io/images/api.jpg)
13 14 15

## Start
``` shell
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
16
npm install NeteaseCloudMusicApi
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
17 18
```

19 20 21
## Usage
``` javascript
var api = require('NeteaseCloudMusicApi').api
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
22 23
api.search('年度之歌',function(data){
    console.log(data)
zhuangtongfa's avatar
zhuangtongfa 已提交
24
})
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
25 26
```
or
27
``` javascript
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
28
import {api} from 'NeteaseCloudMusicApi'
zhuangtongfa's avatar
zhuangtongfa 已提交
29
api.search('年度之歌',data => {
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
30
    console.log(data)
zhuangtongfa's avatar
zhuangtongfa 已提交
31
})
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
32 33
```

34 35 36
## API

### search
37
``` javascript
zhuangtongfa's avatar
zhuangtongfa 已提交
38
api.search(name:String,[callback:function,onlySong:Boolean default:true,limit:Number default:3, offset:Number default:0])
39
```
zhuangtongfa's avatar
zhuangtongfa 已提交
40
说明:onlySong默认为true,如果为false,则返回一个对象,包含songs和mvs,songs和mvs均为数组
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
41

42
### lrc
43
``` javascript
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
44
api.lrc(id:Number,[callback:function,lv:Number default:-1])
45
```
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
46

47
### song
48 49

``` javascript
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
50
api.song(id:Number,[callback:function])
51 52 53 54 55 56 57 58 59 60 61 62 63
```

### getArtistAlbums

``` javascript
api.getArtistAlbums(id:Number,[callback:function,limit:Number default:3, offset:Number default:0])
```

## getAlbums

``` javascript
api.getAlbums(id:Number,[callback:function])
```
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
64

C
CeBkCn 已提交
65 66 67 68 69
## getPlaylists

``` javascript
api.Playlists(id:Number,[callback:function])
```
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
70

71
## License
zhuangtongfa's avatar
zhuangtongfa 已提交
72
[The MIT License (MIT)](LICENSE)