项目简介
FEBLOG API 是一个基于 Node.js 和 Koa2 框架的 RESTful API 服务器。它支持多种关系型数据库,如 PostgreSQL、MySQL、MariaDB、SQLite、MSSQL,并使用 Sequelize 作为 ORM。该项目支持跨域请求、JSON 数据传输、JWT 身份认证等功能,适用于构建前后端分离的应用。
项目的主要特性和功能
- 跨域支持:通过配置支持跨域请求。
- 数据传输格式:支持
application/x-www-form-urlencoded
、multipart/form-data
、application/json
格式的 POST、PUT、DELETE 请求。 - JWT 身份认证:通过 JWT 实现用户身份认证。
- 数据库支持:使用 Sequelize ORM 支持 PostgreSQL、MySQL、MariaDB、SQLite、MSSQL 等多种数据库。
- 语法检查:使用 ESLint 进行 JavaScript 语法检查。
- 插件支持:集成了多个常用插件,如 koa-body、koa-router、koa-static2 等。
安装使用步骤
假设用户已经下载了本项目的源码文件,以下是使用步骤:
1. 安装依赖
bash
cd feblog-api
npm install
2. 开发环境启动
bash
npm run dev
3. 生产环境启动
bash
npm run production
4. 使用 PM2 部署
bash
pm2 start pm2.json
5. Docker 部署
bash
docker pull node
docker run -itd --name RESTfulAPI -v `pwd`:/usr/src/app -w /usr/src/app node node ./dist/app.js
6. Linux/Mac 直接后台运行生产环境代码
bash
nohup node ./dist/app.js > logs/out.log &
7. 前端配合 Vue-cli 部署
前端 Vue-cli(Vue2)运行 npm run build
后生成所有静态资源文件,推荐使用 Nginx 处理静态资源,然后通过上述任意一种方法部署 RESTful API 服务器。前后端是完全分离的,请注意 Koa2 RESTful API Server 项目中 config/main.json
里面的跨域配置。
注意:使用前,请确保您的 Node.js 版本大于等于 v8.0.0(建议 v11.13.0),NPM 大于等于 v5.0.0。建议使用 yarn 代替 npm。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】