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

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

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

31 32 33
## API

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

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

43
### song
44 45

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

### 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 已提交
60 61


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