Koa2 API Template Save Abandoned

一个基于Koa2轻量级的nodejs后台服务RESTful API Server模板,为客户端提供api接口数据

Project README

Koa2 RESTful API 服务器模板

这是一个基于Koa2的轻量级RESTful API Server模板,支持ES6、ES7。
基于koa2-API-scaffold项目,并且在此基础上做了修改。
项目使用说明请参考上面链接.

使用的技术栈

  • koa2 - HTTP framework.
  • koa-body - A full-feature koa body parser middleware.
  • koa-router - Router middleware for koa.
  • koa-jwt - Koa middleware for validating JSON Web Tokens
  • jsonwebtoken - JsonWebToken implementation for node.js
  • koa-static2 - Middleware for Koa2 to serve a folder under a name declared by user.
  • koa-logger - Development style logger middleware for Koa.
  • nodemailer - Send e-mails with Node.JS.
  • mysql2 - fast node-mysql compatible mysql driver for node.js
  • sequelize - An easy-to-use multi SQL dialect ORM for Node.js
  • md5 - Encrypt data such as password
  • Eslint + Standard style - Standard style for code consistency
  • Nodemon - to reload automatically the server in development
  • downloadjs - file downloading using client-side javascript

特性

  • async/await
  • Upload file
  • Download file
  • Authentication jwt
  • Basic User model
  • Basic Fileupload model

前端项目示例

客户端 vue-ssr-front-todo 通过和客户端结合后以前后端分离的方式演示网站开发中的常见技术示例

开发使用说明

由于使用MYSQL数据库,启动服务前请先修改数据库配置 修改config.js文件的DB连接的用户名、密码和数据库名

$ npm install
//or 可以通过如下操作解决npm速度慢的问题
$ npm install --registry=https://registry.npm.taobao.org
# 本地开发 开启服务
$ npm run dev # 可执行npm start跳过ESlint检查。

访问: http://127.0.0.1:3000/public/get

Node.js版本

node >= 8.0.0
npm >= 5.0.0

Open Source Agenda is not affiliated with "Koa2 API Template" Project. README Source: yzijun/koa2-API-template
Stars
35
Open Issues
2
Last Commit
6 years ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating