README.MD 1.3 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
</p>
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
7
![](http://binaryify.github.io/images/api.jpg)
8 9 10

## Start
``` shell
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
11
npm install NeteaseCloudMusicApi
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
12 13
```

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

29 30 31
## API

### search
32 33 34
``` javascript
api.search(name:String,[callback:function,limit:Number default:3, offset:Number default:0])
```
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
35

36
### lrc
37
``` javascript
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
38
api.lrc(id:Number,[callback:function,lv:Number default:-1])
39
```
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
40

41
### song
42 43

``` javascript
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
44
api.song(id:Number,[callback:function])
45 46 47 48 49 50 51 52 53 54 55 56 57
```

### 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 已提交
58 59


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