编写REST API

REST API规范
编写REST API,实际上就是编写处理HTTP请求的async函数,不过,REST请求和普通的HTTP请求有几个特殊的地方:json

REST请求仍然是标准的HTTP请求,可是,除了GET请求外,POST、PUT等请求的body是JSON数据格式,请求的Content-Type为application/json;
REST响应返回的结果是JSON数据格式,所以,响应的Content-Type也是application/json。
REST规范定义了资源的通用访问格式,虽然它不是一个强制要求,但遵照该规范能够让人易于理解。api

例如,商品Product就是一种资源。获取全部Product的URL以下:app

GET /api/products
而获取某个指定的Product,例如,id为123的Product,其URL以下:async

GET /api/products/123
新建一个Product使用POST请求,JSON数据包含在body中,URL以下:函数

POST /api/products
更新一个Product使用PUT请求,例如,更新id为123的Product,其URL以下:post

PUT /api/products/123
删除一个Product使用DELETE请求,例如,删除id为123的Product,其URL以下:排序

DELETE /api/products/123
资源还能够按层次组织。例如,获取某个Product的全部评论,使用:资源

GET /api/products/123/reviews
当咱们只须要获取部分数据时,可经过参数限制返回的结果集,例如,返回第2页评论,每页10项,按时间排序:get

GET /api/products/123/reviews?page=2&size=10&sort=timeio

请求 地址 说明 get /messages 获取全部消息 post /message 建立一个消息 put /message 修改消息内容 patch /message/text 修改消息的 text 字段 get /message/id 根据 ID 获取消息 delete /message/id 根据 ID 删除消息

相关文章
相关标签/搜索