node RESTful API开发

一、RESTful API 路由

REST 介绍:https://www.jianshu.com/p/9bb7e6c683a3

restful其实本身并不是一个新鲜的东西,最早是在2000年由Roy Thomas Fielding博士在他的博士论文中提出。这个设计思想过于超前,所以早些年一直处于不温不火的状态。直到近年来,互联网业务高速发展,系统架构越来越复杂,移动互联网的兴起,前后端分离架构的流行,人们发现原来这套用于超文本传输的协议是如此适合用于设计基于互联网的api接口,基于http动词以及标准的http status返回信息,能够非常好的描述api的特性,并且可读性非常好。

早期的路由设计,一般是一个功能一个路由,容易产生歧义,不优雅

localhost:3000/student_add?id=12&name=张三&sex=男

localhost:3000/student_del?id=12

/student_upate?id=2

/student_edit?id=2

/student_modify?id=2

RESTful 路由:结构清晰简单、易于理解,不会产生歧义,扩展方便,正得到越来越多互联网项目的使用。

特点:

GET localhost:3000/student/id/12 访问id为12的学生信息

POST localhost:3000/student/id/12 修改id为12的学生信息

DELETE localhost:3000/student/id/12 删除id为12的学生

propfind localhost:3000/student/id/12 查看id为12的学生有没有被占用

PUT localhost:3000/student/id/12 添加一个id为12的学生信息

GET localhost:3000/teacher/id/122

总结:路由中只有“名词”,具体干啥由“动词”(请求方法)决定

express可以识别的http请求类型:

checkout move patch lock unlock head copy connect ....

RESTful API 除了http 请求方法,还设计好了常用的状态码:

200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
202 Accepted - []:表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]:用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
401 Unauthorized - [
]:表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [
]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

原文地址:https://www.cnblogs.com/bnzw/p/13973689.html