koa2 mysql脚手架_基于Koa2的轻量级脚手架 – koa2-API-scaffold

Koa2 RESTful API 服务器脚手架

这是一个基于Koa2的轻量级RESTful API Server脚手架，支持ES6。

约定使用JSON格式传输数据，POST、PUT、DELET方法支持的Content-Type为application/x-www-form-urlencoded、multipart/form-data、application/json可配置支持跨域。非上传文件推荐application/x-www-form-urlencoded。通常情况下返回application/json格式的JSON数据。

可选用mongodb、redis非关系型数据库和PostgreSQL, MySQL, MariaDB, SQLite, MSSQL关系型数据库，考虑RESTful API Server的实际开发需要，这里通过sequelize.js作为ORM，同时提通过Promise执行SQL直接操作Mysql数据库的方法(不管什么方法，注意安全哦)。

此脚手架只安装了一些和Koa2不冲突的搭建RESTful API Server的必要插件，附带每一个插件的说明。采用ESlint进行语法检查。

因此脚手架主要提供RESTful API，故暂时不考虑前端静态资源处理，只提供静态资源访问的基本方法便于访问用户上传到服务器的图片等资源。基本目录结构与vue-cli保持一致，可配合React、AngularJS、Vue.js等前端框架使用。在Cordova/PhoneGap中使用时需要开启跨域功能。

免责声明：此脚手架仅为方便开发提供基础环境，任何人或组织均可随意克隆使用，使用引入的框架需遵循原作者规定的相关协议(框架列表及来源地址在下方)。采用此脚手架产生的任何后果请自行承担，本人不对此脚手架负任何法律责任，使用即代表同意此条。

目前暂未加入软件测试模块，下一个版本会加入该功能并提供集成方案。

China大陆用户请自行优化网络。

开发使用说明

$ git clone https://github.com/yi-ge/koa2-API-scaffold.git

$ cd mv koa2-API-scaffold

$ npm install

$ npm run dev # 可执行npm start跳过ESlint检查。

访问： http://127.0.0.1:3000/

调试说明

$ npm run dev --debug

Or

$ npm start --debug

开发环境部署

生成node直接可以执行的代码到dist目录：

$ npm run build

$ npm run production # 生产模式运行

Or

$ node dist/app.js

PM2部署说明

提供了PM2部署RESTful API Server的示例配置，位于“pm2.js”文件中。

$ pm2 start pm2.js

Docker部署说明

$ docker pull node

$ docker run -itd --name RESTfulAPI -v `pwd`:/usr/src/app -w /usr/src/app node node ./dist/app.js

通过’docker ps’查看是否运行成功及运行状态

Linux/Mac 直接后台运行生产环境代码

有时候为了简单，我们也这样做：

$ nohup node ./dist/app.js > logs/out.log &

查看运行状态(如果有’node app.js’出现则说明正在后台运行)：

$ ps aux|grep app.js

查看运行日志

$ cat logs/out.log

监控运行状态

$ tail -f logs/out.log

配合Vue-cli部署说明

Vue-cli(Vue2)运行’npm run build’后会在’dist’目录中生成所有静态资源文件。推荐使用Nginx处理静态资源以达最佳利用效果，然后通过上述任意一种方法部署RESTful API服务器。前后端是完全分离的，请注意Koa2 RESTful API Server项目中config/main.json里面的跨域配置。

推荐的Nginx配置文件：

server

{

listen 80;

listen [::]:80;

server_name abc.com www.abc.com; #绑定域名

index index.html index.htm;

root /www/app/dist; #Vue-cli编译后的dist目录

location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$

{

expires 30d;

}

location ~ .*\.(js|css)?$

{

expires 12h;

}

location ~ /\.

{

deny all;

}

access_log off; #访问日志路径

}

Docker中Nginx运行命令(将上述配置文件任意命名放置于nginx_config目录中即可)：

$ docker run -itd -p 80:80 -p 443:443 -v `pwd`/nginx_config:/etc/nginx/conf.d nginx

各类主流框架调用RESTful API的示例代码(仅供参考)

AngularJS (Ionic同)

$http({

method: 'post',

url: 'http://localhost:3000/xxx',

data: {para1:'para1',para2:'para2'},

headers: {

'Content-Type': 'application/x-www-form-urlencoded'

}

}).success(function (data) {

}).error(function (data) {

})

jQuery

$.ajax({

cache: false,

type: 'POST',

url: 'http://localhost:3000/xxx',

data: {

para1: para1

},

async: false,

dataType: 'json',

success: function (result) {

},

error: function (err) {

console.log(err)

}

})

// 上传文件

//创建FormData对象

var data = new FormData()

//为FormData对象添加数据

//

$.each($('#inputfile')[0].files, function (i, file) {

data.append('upload_file', file)

})

$.ajax({

url: 'http://127.0.0.1:3000/api/upload_oss_img_demo',

type: 'POST',

data: data,

cache: false,

contentType: false, //不可缺

processData: false, //不可缺

success: function (data) {

console.log(data)

if (data.result == 'ok') {

$('#zzzz').attr('src', data.img_url)

}

}

})

MUI

mui.ajax({ url: 'http://localhost:3000/xxx', dataType: 'json',

success: function(data){

},

error: function(data){

console.log('error!')

}

})

JavaScript

var xhr = new XMLHttpRequest()

xhr.open('POST', 'http://localhost:3000/xxx', true) //POST或GET，true(异步)或 false(同步)

xhr.setRequestHeader('Content-type', 'application/x-www-form-urlencoded')

xhr.withCredentials = true

xhr.onreadystatechange = function () {

if (obj.readyState == 4 && obj.status == 200 || obj.status == 304) {

var gotServices = JSON.parse(xhr.responseText)

}else{

console.log('ajax失败了')

}

}

xhr.send({para1: para1})

vue-resource

// global Vue object

Vue.http.post('/someUrl', [body], {

headers: {'Content-type', 'application/x-www-form-urlencoded'}

}).then(successCallback, errorCallback)

fetch

fetch('/users', {

method: 'POST',

headers: {

'Content-Type': 'application/json'

},

body: JSON.stringify({

name: 'Hubot',

login: 'hubot',

})

}).then(function(response) {

// response.text()

}).then(function(body) {

// body

})

// 文件上传

var input = document.querySelector('input[type='file']')

var data = new FormData()

data.append('file', input.files[0])

data.append('user', 'hubot')

fetch('/avatars', {

method: 'POST',

body: data

})

superagent

request.post('/user')

.set('Content-Type', 'application/json')

.send('{'name':'tj','pet':'tobi'}')

.end(callback)

request

request.post('/api').form({key:'value'}), function(err,httpResponse,body){ /* ... */ })

在React中可以将上述任意方法其置于componentDidMount()中，Vue.js同理。

彻底移除ESlint方法

删除package.json的devDependencies中所有eslint开头的插件，根目录下的“.eslintignore、.eslintrc.js”文件，并且修改package.json的dev为：

'dev': 'gulp start'

删除gulpfile.js中的lint、eslint_start两个任务，并且把default改为“gulp.task(‘default’, [‘start’]”。