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

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

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

33 34 35
## API

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

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

45
### song
46 47

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

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

C
CeBkCn 已提交
63 64 65 66 67
## getPlaylists

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

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