# koa2-api

**Repository Path**: bsonjia/koa-openlayers

## Basic Information

- **Project Name**: koa2-api
- **Description**: 目标是做一个通用的koa后端接口api
项目vue2.6+openlayers6的后端，采用的koa.js
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-06-28
- **Last Updated**: 2023-06-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# koa-openlayers(一个基于koa.js的后端框架)

## 一、安装依赖

```bash
cnpm i
```

## 二、启动命令

```bash
npm run start
```

> 已经使用nodemon进行热加载
> 学习视频地址<https://www.bilibili.com/video/BV19b4y1a7Mg?p=2>

## 三、目录结构

- index.ts为项目入口文件
- app 为项目目录
- assets为静态资源目录，此目录可直接访问
- logs 日志目录
- tests 测试目录
- utils 工具

## 四、依赖中间件

- nodemon 热加载
- async-validator 表单异步验证库-数据校验
- dotenv 配置环境变量

- koa-body 上传文件
- koa-send 下载文件
- koa-static 静态文件

- log4js 日志管理

- @types/node与@types/validator处理数据库的前提工具
- sequelize、sequelize-typescript 、reflect-metadata处理数据库---需要修改tsconfig.json

- jest 单元测试
- supertest 单元测试

## 五、基础三层MVC模式架构

基础三层模式架构：Controller、Service、Model
数据流向是Router-->Controller-->Service-->Model-->Database

模型是 Sequelize 的本质. 模型是代表数据库中表的抽象. 在 Sequelize 中,它是一个 Model 的扩展类.