trello01:后端搭建

开发依赖:

koa : 后端的主框架。

koa-router : 基于 Koa 的路由。

koa-static-cache : koa 静态文件代理。

koa-ts-controllers : 基于 Koa 和 TypeScript 构建的路由控制系统,它提供了各种装饰器来构建 RESTful 风格的 API。

mysql2 : NodeJS 连接操作 MySQL 的库。

sequelize : 一个功能更丰富和强大的数据库操作库,支持 MySQL、MSSQL、SQLite 等数据库,提供了 ORM、事务 以及 Promise 等支持。

sequelize-typescript : sequelize 的 TypeScript 版。

class-validator : 基于 validator.js 和 TypeScript 的数据验证工具,对用户或者接口调用传入的数据进行校验。

jsonwebtoken : JWT 鉴权库。

moment : 日期时间处理工具。

开发辅助工具:

ts-node-dev : ts-node 的 dev 版,实现了热重载。

sequelize-cli : sequelize 提供了的 CLI 工具,可以通过它来维护数据库。

接口规范:

遵循 RESTful 规范,合理的利用 请求方法、状态码 等来设计 API。

资源路径:因为当前应用没有把接口数据与静态资源(如图片等)进行分开放置,所以为了进行区分,接口以 /api 作为前缀,静态资源以 /public 作为前缀。

为了更方便的对接口进行管理以及后续的升级,路径后同时携带当前接口的版本,如:/api/v1/login。

项目搭建:

初始化项目:创建项目目录(backend), npm init 。

创建tsconfig.json文件:

tsconfig.json配置

根目录下创建文件夹:

src目录:存放源码。

app.ts:在src下创建项目启动入口文件。

controllers: src下创建项目控制器类文件。

configs:src下创建项目配置文件,例如:不同环境下(开发、测试、生成等)主机地址,端口,数据库连接信息等。在configs目录下创建index.ts :

configs/index.ts

此时,代码会出现报错。因为默认情况下,TypeScript 没有内置 node 相关的类型声明,我们需要手动安装:npm i -D @types/node,安装完成以后,报错消失。

npm i -D @types/node

入口文件:

安装koa以及类型声明文件 : npm i koa  、 npm i -D @types/koa  (Koa不是TS编写的,引用koa的时候会报错)。

app.ts

启动项目:

在开发阶段,借助ts-node-dev工具帮助我们运行ts文件: npm i -D ts-node-dev ,他还具有热重载功能。

ts文件的编译:npm i -D typescript 。

启动项目,在package.json中配置启动命令:"dev": "ts-node-dev ./src/app.ts" ,配置完成以后 :npm run dev 。

package.json

基于 TypeScript 的路由控制框架:koa-ts-controllers 

在 koa-ts-controllers 中,利用了 TypeScript 的装饰器,我们可以直接在指定类的某个方法中对其进行路由绑定。而且通过它提供的功能,我们可以更方便实现符合 RESTful 规范的接口。

npm i koa-ts-controllers

bootstrapControllers : koa-ts-controllers 的主要函数,用来初始化应用控制器和路由绑定。

router : 使用koa-router路由库。

basePath:设置访问接口路径的前缀,/api。

versions:接口版本,会附加到 basePath 之后,/api/v1。

controllers:控制器类文件的存放目录。

app.ts

装饰器:

controllers下存放了所有的控制器类文件。我们需要将这些类都变成控制类,并绑定其中的类方法到指定的路由中,这就需要用到装饰器。

@Controller(basePath) : 针对类的装饰器,被装饰的类就会成为一个控制器类,只有控制器类下的方法才能与路由进行绑定。basePath:该类中方法绑定的路由的前缀路径。

HTTP请求方法装饰器: @Get(path)  、 @Post(path) 、 @Patch(path) 、@Put(path) 、  @Delete(path)

在controllers文件下创建test.ts文件

启动项目: npm run dev , 通过 http://localhost:8080/api/v1/test/hello 、 http://localhost:8080/api/v1/test/userInfo?id=2 等可以进行访问。此时,会报错:未找到class-validator模块, 安装一下 npm i class-validator 即可。

http://localhost:8080/api/v1/test/hello
 http://localhost:8080/api/v1/test/userInfo?id=2
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350