登录 注册
开源 企业版 高校版 私有云 Gitee AI NEW
扫描微信二维码支付
取消
支付完成
Watch
不关注 关注所有动态 仅关注版本发行动态 关注但不提醒动态
2 Star 7 Fork 1

CKJiang / node-mysql-koa2

代码 Issues 0 Pull Requests 0 Wiki 统计 流水线
服务
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目，私有仓库也完全免费 ：）
免费加入
克隆/下载
分支 2
标签 0
贡献代码
同步代码
创建 Pull Request
了解更多
对比差异 通过 Pull Request 同步
同步更新到分支
通过 Pull Request 同步
将会在向当前分支创建一个 Pull
Request，合入后将完成同步
取消
提示: 由于 Git 不支持空文件夾，创建文件夹后会生成空的 .keep 文件
src
test
.gitignore
LICENSE
README-EN.md
README.md
package.json
tsconfig.json
Loading...
README
MIT

node-mysql-koa2

简体中文 | English

使用完整的ES2015+功能开发Node.js应用程序，支持TypeScript。

项目简介

  • 本项目是一个使用Node.js➕MySQL➕Koa2编写的轻量级Web后端框架
  • MySQL使用Sequelize
  • api文档使用swagger自动生成
  • 使用MVC模式，简单封装，易扩展，可供新手学习，也可以快速上手二次开发
  • 目前实现的demo有：创建用户和获取用户列表。
  • 具体文件结构介绍见文件结构及说明表

项目运行结果

API文档（自动生成）

环境准备

克隆项目

$ git clone --depth=1 https://gitee.com/ckjiang/node-mysql-koa2.git

安装依赖

$ cd node-mysql-koa2
$ npm install

编译

$ npm run build

运行

$ npm run dev

单元测试

$ npm run test

生成测试报告

$ npm run cover

接口文档（自动生成）

文件结构及说明表:

文件名 描述
src/config 环境配置文件，有生产环境和开发环境，如端口号、MySQL、Redis、Mongo等设置
dist 存放编译后的文件
node_modules 所有npm依赖项
src 编译到dist目录的源代码
src/middlewares 拦截请求的中间件，路由头部统一处理等
src/models 存储和检索Mysql数据，对标表结构，文件命名格式为：xxModel.ts，如数据库表名user,文件名为userModel.ts
src/engines 通过模型(models)直接操作数据库
src/handlers 用于路由器和调用engines里对应的模块
src/routers 存放客户端访问的路由文件，使用Joi进行参数验证，可限制接口get、post、put等请求方式，并且在此定义handler，即处理接口的入口函数
src/swaggers Swagger UI for API
src/utils Some common internal interfaces
src/bin/server.ts Entry point to your Koa project
src/app.ts The helper file be used by server.ts
package.json 包含npm依赖项以及 build scripts
tsconfig.json 编译用TypeScript编写的服务器代码的配置设置

本项目提供的Demo说明

graph LR
A(客户端访问user/create) -->B(routers/user.ts)
B--校验参数正确-->C(handlers/userHandler.ts create处理)
C-->D(engines/userEngines.ts create)
D-->E(操作userModel.ts 入库)
E-->F(返回相应数据)

二次开发思路

  • src/routers，存放路由，在改目录下的文件，会由swagger自动生成api文档，供前端访问

  • src/handlers，提供路由处理入口，在routers下写的api，处理函数可通过 handler指定

  • src/engines，涉及数据库操作的，可由handlers下的文件调用

  • src/models，有新表时，需要在此文件夹下新建文件，对标表结构

  • 文件命名检验同个模块的数据，统一命名，如角色功能，对应文件可分别为:

    graph LR
A(routers/role.ts)-.-B(handlers/roleHandler.ts)
B-.-C(engines/roleEngine.ts)
C-.-D(models/roleModel.ts)

  • 具体可看Demo：user

License

  • MIT

  • 如果对你有帮助的话，请你点一个星星 star 鼓励，也可以请我喝杯果汁🍹，或者您有更好的建议和意见，请提出来告知我，可以留言 Issues或加我微信。希望能够帮助到你学习！Thanks！共勉！

MIT License Copyright (c) 2023 CKJiang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Starred
7
Star
7
Fork
1

简介

一个使用Node.js➕MySQL➕Koa2编写的轻量级Web后端框架 展开 收起
MySQL
koa2
Joi
Nodejs
Swagger
暂无标签
https://gitee.com/ckjiang/node-mysql-koa2
NodeJS
TypeScript
100.0%
MIT
使用 MIT 开源许可协议
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
NodeJS
1
https://gitee.com/ckjiang/node-mysql-koa2.git
git@gitee.com:ckjiang/node-mysql-koa2.git
ckjiang
node-mysql-koa2
node-mysql-koa2
master
点此查找更多帮助

搜索帮助

Git 命令在线学习 如何在 Gitee 导入 GitHub 仓库
Git 仓库基础操作
企业版和社区版功能对比
SSH 公钥设置
如何处理代码冲突
仓库体积过大，如何减小？
如何找回被删除的仓库数据
Gitee 产品配额说明
GitHub仓库快速导入Gitee及同步更新
什么是 Release（发行版）
将 PHP 项目自动发布到 packagist.org
评论
仓库举报
回到顶部