#基于webpack构建的 Koa2 restful API 服务器脚手架
这是一个基于 Koa2 的轻量级 RESTful API Server 脚手架，支持 ES6, 支持使用TypeScript编写。
GIT地址：https://github.com/Allenzihan/koa2-mysql-framework.git

此脚手架只安装了一些配合koa2使用的必要插件，不仅提供RESTful API实现，同时也集成了对静态资源的处理，支持跨越，代理转发请求等基础功能。基本上您仅需要关注您的业务开发即可。

脚手架可以根据不同的环境配置不同的信息运行价值，支持开发，测试，生产环境的不同参数配置。

#数据库选型MySQL

当然你也可以根据需要配置其他的关系型数据库，可扩展 sequelize.js 作为 PostgreSQL, MySQL, MariaDB, SQLite, MSSQL 关系型数据库的 ORM，本框架使用MVC分成模式实现，事例上通过SQL去实现对数据库的增、删、查、改操作。

## 目录结构说明

```bash

├── README.md
├── .babelrc                    # Babel 配置文件
├── .gitignore                  # Git 忽略文件列表
├── package.json                # 描述文件
├── process.config.js           # pm2 部署示例文件
├── bin                         # bin入口目录
│   └── www                     # 启动文件入口
├── .vscode                     # VS CODE 调式目录
│   └── launch.json             # 调试配置
├── config                      # 配置文件
│   ├── db.config.js            # 数据库配置文件
│   ├── logger.config.js        # 日志配置文件
│   ├── proxy.config.js         # 代理配置文件
│   └── session.config.js       # session配置文件
├── src                         # 源代码目录，编译后目标源代码位于 dist 目录
│   ├── app.js                  # 入口文件
│   ├── files                   # 存放文件目录
│   ├── middleware              # 中间件目录
│       └── errorRouteCatch.js  # 示例插件 -  router异常处理
│   ├── utils                   # 工具类目录
│   ├── controllers             # 控制器
│       └── usersController.js  # 示例users控制器
│   ├── models                  # 模型层
│   ├── routes                  # 路由层
│         └── users.js          # 示例users路由
│   └── services                # 服务层
│         └── usersService.js   # 示例users服务层
├── public                      # 静态资源目录
└── logs                        # 日志目录
```
## 开发使用说明
```bash
git clone https://github.com/Allenzihan/koa2-mysql-framework.git
cd mv koa2-mysql-framework
npm install
npm run dev
访问： http://127.0.0.1:3000/home
```
## 开发调试说明
支持VSCODE调试 Node.js功能，已经配置好, 启动VSCODE IDE 上的Debug按钮即可调试
## 开发环境
npm run dev
## PM2 部署说明
提供了 PM2 部署 RESTful API Server 的示例配置，位于“process.config.js”文件中。
process.config.js 文件提供了两套环境的配置，分别是测试环境和生产环境的配置
启动测试环境：
npm run uat
如果启动失败，使用pm2 直接启动
pm2 start process.config.js --only uat
启动生产环境：
npm run prod
如果启动失败，使用pm2 直接启动
pm2 start process.config.js --only prod
以上使用pm2启动，需提前安装好pm2模块
PM2 配合 Docker 部署说明： http://pm2.keymetrics.io/docs/usage/docker-pm2-nodejs/
### 关于 Token 使用的特别说明（JWT 身份认证）
app.use(jwt({ 
secret: publicKey.toString()
}).unless({
path: [
/^\/users\/login/,
/^\/home/,
/^\/assets/
] 
}))
在 path 里面的开头路径则不进行身份认证，否则都将进行  鉴权。
前端处理方案：
```javascript
import axios from 'axios'
import { getToken } from './tool'
const DevBaseUrl = 'http://127.0.0.1:8080'
const ProdBashUrl = 'https://xxx.xxx'
let config = {
baseURL: process.env.NODE_ENV !== 'production' ? DevBaseUrl : ProdBashUrl // 配置API接口地址
}
let token = getToken()
if (token) {
config.headers = { Authorization: 'Bearer ' + token }
}
let request = axios.create(config)
// http request 拦截器
axios.interceptors.request.use(
config => {
if (window) {
let token = getToken()
if (token) {
// 判断是否存在token，如果存在的话，则每个http header都加上token
config.headers.Authorization = `Bearer ${token}`
}
}
// if (config.method === 'get') {
//   config.url = config.url + 'timestamp=' + Date.now().toString()
// }
return config
},
err => {
return Promise.reject(err)
}
)
export default request
```
`tool.js`文件
```javascript
// 写 cookies
export let setCookie = function setCookie(name, value, time) {
if (time) {
let strsec = getsec(time)
let exp = new Date()
exp.setTime(exp.getTime() + parseInt(strsec))
document.cookie =
name + '=' + escape(value) + ';expires=' + exp.toGMTString()
} else {
document.cookie = name + '=' + escape(value)
}
}
// 读 cookies
export let getCookie = function(name) {
let reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)')
let arr = document.cookie.match(reg)
return arr ? unescape(arr[2]) : null
}
// 删 cookies
export let delCookie = function(name) {
var exp = new Date()
exp.setTime(exp.getTime() - 1)
var cval = getCookie(name)
if (cval != null) {
document.cookie = name + '=' + cval + ';expires=' + exp.toGMTString()
}
}
// 获取Token
export let getToken = function() {
if (window.sessionStorage && window.sessionStorage.Bearer) {
return window.sessionStorage.Bearer
} else if (window.localStorage && window.localStorage.Bearer) {
return window.localStorage.Bearer
} else if (window.document.cookie) {
return getCookie('Bearer')
}
}
// 设置Token
export let setToken = function(token, rememberTime) {
if (window.sessionStorage) {
window.sessionStorage.Bearer = token
}
if ((rememberTime && window.localStorage) || !window.sessionStorage) {
window.localStorage.Bearer = token
}
if (
window.document.cookie &&
!window.sessionStorage &&
!window.localStorage
) {
if (rememberTime) {
setCookie('Bearer', token, rememberTime)
} else {
setCookie('Bearer', token)
}
}
}
// 删除Token
export let delToken = function() {
if (window.sessionStorage && window.sessionStorage.Bearer) {
window.sessionStorage.removeItem('Bearer')
}
if (window.localStorage && window.localStorage.Bearer) {
window.localStorage.removeItem('Bearer')
}
if (window.document.cookie) {
delCookie('Bearer')
}
}
```
大概原理：
通过某个 API（通常是登录 API）获取成功后的 Token，存于本地，然后每次请求的时候在 Header 带上`Authorization: "Bearer " + token`，通常情况下无需担心本地 Token 被破解。
GIT地址：

https://github.com/Allenzihan/koa2-mysql-framework.git

转载于:https://www.cnblogs.com/allen-tech/p/11382443.html

最好用的koa2+mysql的RESTful API脚手架，mvc架构，支持node调试，pm2部署。相关推荐

  1. python前端调用后端模型_前端调用后端的方法(基于restful接口的mvc架构)

    1.前端调用后台: 建议用你熟悉的一门服务端程序,例如ASP,PHP,JSP,C#这些都可以,然后把需要的数据从数据库中获得,回传给客户端浏览器(其实一般就是写到HTML中,或者生成XML文件)然后在 ...

  2. 开源的 Restful Api 集成测试工具 Hitchhiker

    Hitchhiker 是一款开源的 Restful Api 集成测试工具,你可以在轻松部署到本地,和你的team成员一起管理Api. 先上图看看: 简单介绍 背景是Team在开发一些Api,这些Api ...

  3. RESTful API的理解

    技术交流的时候遇到了这样的一个问题,被问及开发中用到的是不是Restful API,我说的是,我们现在用到的不属于完全是Restful API.因为我了解到的Restful API,是 通过具体的UR ...

  4. python django restful_详解Django rest_framework实现RESTful API

    一.什么是REST 面向资源是REST最明显的特征,资源是一种看待服务器的方式,将服务器看作是由很多离散的资源组成.每个资源是服务器上一个可命名的抽象概念.因为资源是一个抽象的概念,所以它不仅仅能代表 ...

  5. Docker——基于HubServing部署全套PaddleOCR Restful API服务（CPU版本）

    说明 1.同时部署ocr_det.ocr_cls.ocr_rec.ocr_system 2.基于https://gitee.com/paddlepaddle/PaddleOCR/blob/v2.0.0 ...

  6. 使用ASP.NET Core 3.x 构建 RESTful API - 1. 开始

    以前写过ASP.NET Core 2.x的REST API文章,今年再更新一下到3.0版本. 预备知识:ASP.NET Core 和 C# 工具:Visual Studio 2019最新版(VSCod ...

  7. App后台开发运维和架构实践学习总结（2）——RESTful API设计技巧

    前言 移动互联网时代,RESTful API成为越来越重要的移动端和服务器端交互的形式.尤其是在很多互联网公司或者传统行业拥抱移动互联网的时候,一套设计良好的Restful API能够帮助互联网产品支 ...

  8. 前端请求restful风格接口怎么传参_浅谈Restful API 的请求规范

    前言 在SpringMVC架构上进行开发,开发者一直在使用jsp.valocity或者其他页面模版作为表现层面,前端工程师需要将设计师的设计图转换为静态的html页面,然后交付给后端将静态的html页 ...

  9. Restful API 的接口规范

    发展背景及简介 网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备-).因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致 ...

最新文章

  1. 1088 Rational Arithmetic (20 分)【难度: 简单 / 知识点: 模拟】
  2. python的序列化是什么意思_python 什么是对象序列化
  3. 角距离恒星_恒星问卷调查的10倍机器学习生产率
  4. mysql 里面不等于符号_mysql 不等于 符号写法
  5. 多线程程序中操作的原子性
  6. linux 向程序发送信号,Linux下的信号处理
  7. MySql中not in的优化
  8. 【POJ 1269】判断两直线相交
  9. cruzer php sandisk 闪迪u盘量产工具_SanDisk Cruzer Micro(U盘量产工具) V1.0 电脑版
  10. 前端面试必考的「 Webpack详解 」都在这了
  11. 黑客教父郭盛华：11个IDA Pro反汇编程序的替代品
  12. Linux上安装SAPGUI(附安装包)
  13. treegrid 与java交互_EXTJS实现的TREEGRID（后台java,框架SpringMVC）
  14. PR常见问题「六」pr去水印的几种方法
  15. 你觉得创业失败后的那些人，再去公司上班，能待下去吗？
  16. inputStream 和FileInputStream 转换
  17. Web 压测工具介绍
  18. 监控硬盘与计算机硬盘区别,视频存储烦恼 监控硬盘和普通硬盘区别
  19. django 快速实现文件上传(django2.0)
  20. 启动TomCat的流程

热门文章

  1. Simple Polygon Embedding CodeForces - 1354C1（计算几何）
  2. python统计分析--2.预分析：异常值、缺失值处理
  3. 自己用嵌入式系统搭建云服务器,嵌入式服务器搭建
  4. android最新框架,XUpdate 一个轻量级、高可用性的Android版本更新框架
  5. java.lang.ClassNotFoundException: Cannot find class: com.mysql.jdbc.Driver解决办法
  6. 抖音云控_抖音云控/快手云控：引领5G电商短视频新潮流
  7. zblog php版调用代码,zblogphp调用指定单篇文章代码升级版
  8. 计算机体系结构----常见英文缩写（待更....）
  9. [深度学习] 分布式Horovod介绍（四）
  10. 关于I2C和SPI总线协议