十个书写Node.js REST API的最佳实践(上)

原文:10 Best Practices for Writing Node.js REST APIs

我们会通过本文介绍下书写Node.js REST API的最佳实践,包括各个主题,像是命名路由、认证、黑盒测试以及对相关资源使用合适的缓存头。

对于Node.js来说最流行的一个用例就是用其来书写RESTful API。尽管如此,当我们使用监控工具来帮助用户排查问题时,我们总是能感受到在REST API上开发者们有很多的问题。

我希望这些最佳实践能够对你有所帮助。

1. 使用HTTP方法和API路由

设想一下你正在构建Node.js RESTful API用以用来创建、更新、获取或者删除用户。这些操作HTTP已经有可以胜任的工具集:POST,PUT, GET, PATCH DELETE

作为最佳实践,你的API路由应该一直使用名词作为资源id。涉及到用的资源相关的,路由机制也可以这样:

  • POST /user 或者 PUT /user:/id 来创建新用户
  • GET /user 来获取列表的用户
  • GET /user/:id 来获得某一个用户
  • PATCH /user/:id 来修改已有的用户记录
  • DELETE /user/:id 来删除一个用户

2. 正确地使用HTTP状态码

如果处理请求时出了问题,你必须在响应里设置正确的状态码:

  • 2xx,如果一切都ok
  • 3xx,如果资源被移除
  • 4xx,如果因为服务器错误导致请求无法实现 (例如请求一个不存在的资源)
  • 5xx, 如果API测出现问题 (例如异常发生)

如果你正在使用Express,设置状态码就是这么简单 res.status(500).send({error: 'Internal server error happened'})。 和使用Restify很类似:res.status(201).

查看list of HTTP status codes以寻求完整列表

3.使用HTTP头来设置Medata

使用HTTP头把metadata加到要发送的负载上。像这样的头可以是在如下信息的上:

  • 页码
  • 速率限制
  • 或者是认证.

标准化HTTP头的列表可以在 这里 被找到。

如果你需要在你的相应头里面设置任何自定义的metadata,给它们加上X前缀是最佳实践。例如,之前如果你在使用CSRF token时,把其命名为X-Csrf-Token是很普遍(但不标准)的做法。无论如何随着RFC 6648的发布,这些都已经被废弃了。新API最好不要使用会和其他应用发生冲突的header名。例如,OpenStack在它们的header前加上了OpenStack

OpenStack-Identity-Account-ID  
OpenStack-Networking-Host-Name  
OpenStack-Object-Storage-Policy

需要注意的是HTTP标准里并没有任何header尺寸限制的定义;然而,出于实际原因Node.js对header对象添加了80KB大小的限制。

“不要让HTTP header(包括状态行)超过HTTP_MAX_HEADER_SIZE。这一检查是为了保护嵌入机免受拒绝服务攻击,这一攻击里攻击者可以给我们发送一个没有结尾的header,这会导致嵌入机一直缓冲” 来自 Node.js HTTP 解析器

4 为你的Node.js REST API挑选合适的框架

挑选最适合你用例的框架是很重要的。

Express, Koa 亦或是 Hapi

ExpressKoaHapi 可以被用来创造浏览器应用,同样的,它们支持模版和渲染 —— 只需要来命名几个特性。如果你的应用也需要提供用户界面,使用它们很有必要。

Restify

另一方面,Restify致力于帮助你构建REST服务。其存在的意思便在于让你构建“严格的”可维护可观察的API服务。Restify同样可以和自动化的DTrace协作支持你所有的handler。

Restify主要被用于像npm或者Netflix的应用生产里。

接下篇《十个书写Node.js REST API的最佳实践(下)》

原文链接:

编辑于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏从流域到海域

在浏览器地址栏输入百度网址之后的故事(面试必考)

面试的时候,面试官经常会问这样的问题,我在浏览器地址栏输入”www.baidu.com”,之后发生了哪些事情呢,这个问题其实是想问你与网页访问有关的网络协议,下...

1955
来自专栏北京马哥教育

又见KeepAlive

最近工作中遇到一个问题,想把它记录下来,场景是这样的: ? 从上图可以看出,用户通过Client访问的是LVS的VIP, VIP后端挂载的RealServer是...

4476
来自专栏技术达人

NAT穿透技术详解

传统的C/S结构是每个客户端均知道中心化的SERVER,由客户端主动与SERVER进行通信。

2334
来自专栏吴伟祥

计算机网络基础知识总结 转

计算机网络学习的核心内容就是网络协议的学习。网络协议是为计算机网络中进行数据交换而建立的规则、标准或者说是约定的集合。因为不同用户的数据终端可能采取的字符集是不...

521
来自专栏Danny的专栏

必备的网络常用测试命令(tracert命令)

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/huyuyang6688/article/...

4062
来自专栏FreeBuf

T50:一款优秀的网站压力测试工具

T50是一款网络层压力测试工具。 该工具在检查完“/usr/include/linux”之后,会选择下面的协议进行测试: a) ICMP – Interne...

2626
来自专栏FreeBuf

MOTS攻击技术分析

背景 我们经常遇到这样一个场景:在用户现场通过端口镜像方式对流量做镜像,用来分析数据包或者审计的时候,疑心较大的用户总是怀疑其数据会被篡改或客户端信任的结果并非...

2208
来自专栏FreeBuf

Kali Linux渗透基础知识整理(二)漏洞扫描

* 原创作者:sysorem,本文属FreeBuf原创奖励计划 漏洞扫描 网络流量 Nmap Hping3 Nessus whatweb DirBuster j...

3428
来自专栏Java进阶架构师

一篇文章带你详解 TCP/IP 协议(完结)

前面的第一二三章已在上篇讲解,还没看过的可以先看看:一篇文章带你详解 TCP/IP 协议

972
来自专栏L宝宝聊IT

管理ESXI网络

2165

扫码关注云+社区