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

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

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

32 33 34
## API

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

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

44
### song
45 46

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

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


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