Node.js开发RESTful API

REST

  1. CS架构:前后端分离,服务端专注于数据存储,前端专注UI
  2. 无状态:所有用户会话保存在客户端,服务端不再保存
  3. 缓存:所有服务端响应都要被标记是否缓存
  4. 统一接口:
    1 资源的标识,https://api.guthub.com/users
    2 通过表述来操作资源,即客户端通过JSON传数据到服务端
    3 自描述消息,即请求或响应必须提供足够的信息让人理解,包括媒体类型HTTP方法缓存等等
    4 点击链接跳转
  5. 分层系统
  6. 按需代码,即客户端可以下载运行服务器传来的代码

最佳实践

  1. URI使用名词复数,/users
  2. URI使用嵌套解释一对多或多对多关系:
    /questions/:questionId/answers/:answerId/comments/:id
  3. 使用正确的HTTP方法
  4. 不符合CRUD时,使用POST/action/资源
  5. 当CRUD时,CRU的响应为数据,D为204状态码

Koa

  1. 洋葱模型,await next()可以理解为等待下一个中间件执行完毕
  2. HTTP的options方法:检测服务器支持的请求方法;CORS跨域的预检请求
  3. allowedMethods方法,用于响应HTTP的options方法;返回405和501状态码
  4. Class组织控制器
  5. 错误处理,在所有中间件前放置错误处理中间件(洋葱模型):
app.use(async (ctx, next) => {
  try{
    await next()
  }  catch( err ){
   /* your code */
}
})
  1. 使用路有前缀
const router = new Router({ prefix: '/users' });

JWT

第一次认证成功后返回token,之后在过期时间内的每次请求都会带上这个token,它的主要方法如下:

  • .sign()
  • .verify()
  • 在koa中使用:
const jwt = require('koa-jwt');
const auth = jwt({ /*秘钥*/ });
//其中,认证信息放在ctx.state上

工具

  1. nodemon,自动重启包
  2. postman,用于测试API
  3. koa-json-error,用于错误处理中间件
  4. cross-env,跨平台环境变量
  5. koa-paraeter,用于校验参数
  6. koa-jwt,用于JWT校验
  7. koa-static,某目录下提供静态服务,使其支持HTTP方法
  8. Math.max(),返回较大数值

Mongoose

  1. 包含用法
async listFollowers(ctx) {
    const users = await User.find({ following: ctx.params.id });
    ctx.body = users;
}
  1. 匹配,$or
  2. 时间戳:{ timestamps: true }
  3. 模糊搜索:.find({ content: new RegExp(ctx.query.q)})
  4. 分页:limit 配合skip
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,012评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,589评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,819评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,652评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,954评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,381评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,687评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,404评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,082评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,355评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,880评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,249评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,864评论 3 232
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,007评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,760评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,394评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,281评论 2 259

推荐阅读更多精彩内容