# API

**Repository Path**: quyihuang/API

## Basic Information

- **Project Name**: API
- **Description**: 自己写的几个简单API，包括网易云音乐等等。
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2019-06-28
- **Last Updated**: 2021-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API

#### 介绍
自己写的几个简单API，包括网易云音乐等等。

#### 软件架构
本API的主要原理是就是解析json，除了借用了网易云官方的API，并无使用任何第三方API。  

#### 安装教程

1. config 里面有三个配置文件，其中base可以不动，local和production用其一即可，需要将production或者local设置为环境变量，例如linux/windows下分别是 export/set ops_config=local/production。  
2. python环境的配置分别在主目录下的requirements.txt文件,可能有一些用不上的扩展包，但是影响不是很大。     
3. 在上述配置完成后，主目录可以用python manager.py runserver 单线程启动项目，进行调试，推荐使用nginx和uwsgi部署项目。    
4. 本flask框架整合了链接管理器，版本管理器，404拦截器，改写了一些常用方法，flask类的改写里面注释掉了db，想用数据库需要取消注释，详见application.py 和 manager.py以及www.py。    
5. 由于之前写的时候并不知道网易云官方的两个api，所以写的时候整合进去了数据库和爬虫以及多线程，导致有很多无用代码。    
6. 目前的版本是最终版本，无需爬虫，无需数据库，单线程，主要核心代码基本在web\controllers\CouldMusicEasy.py中。   

#### 使用说明

1. 现暂有两个API，一个是网易云音乐API，一个是随机名言警句的简单API，均用Python Flask编写。  
2. 名言警句API，这个比较简单，域名 + myhomepage/aphorism。
3. 网易云API是为了适配Aplayer.js做一个网页播放器而设计，有三种输出结果：   
    3.1 域名 + /couldmusiceasy/type=playlist?id=歌单id        
    3.2 域名 + /couldmusiceasy/type=lrc?id=歌曲id        
    3.3 域名 + /couldmusiceasy/type=url?id=歌曲id
	
举例：      
    3.1 获取歌单 https://api.quyihuang.cn/couldmusiceasy/type=playlist?id=2861986657   
    3.2 获取歌词 https://api.quyihuang.cn/couldmusiceasy/type=lrc?id=29122124     
    3.3 下载地址 https://api.quyihuang.cn/couldmusiceasy/type=url?id=29122124     
        
#### 测试页面  
主目录下有个前端测试文件，将html中ajax部分的url替换成3.1的域名即可。