为什么要用Put/Delete接口：Restful API简介

最新推荐文章于 2024-03-07 15:59:06 发布
最新推荐文章于 2024-03-07 15:59:06 发布
阅读量2.1k 收藏 2
点赞数 3
原文链接：http://www.bewindoweb.com/221.html
版权

博客文章

Articles

嗖嗖搜

Dwg

友链

Friends

一枚萌新

About

文章目录

前言HTTP/1.1的八种方法Rest和Restful API 1、资源和表述 2、资源的链接 3、状态和转移 4、状态码

为什么要用Put/Delete接口：Restful API简介

最后更新于2018年11月15日 / 7198次浏览 / 2次点赞 / 0条评论

 PATCH，Restful API

前言

最近发现小伙伴们写的API不仅仅有Get/Post，还有大量的Put/Patch/Delete，其实是有点疑惑的：所有的这些操作使用Post不就都能搞定吗？​事实确实如此，Post能够搞定一切的需求。那为什么还要使用专门的Put、Patch、Delete呢？理由就是为了构建Restful架构。

HTTP/1.1的八种方法

HTTP（HyperText Transfer Protocol，超文本传输协议）是应用层的无状态网络协议，2015年提出了HTTP2.0，但是目前用得最多的还是HTTP1.1。HTTP1.1定义了八种方法来操作资源：

方法 初始来源作用描述
 Get HTTP 1.0

请求指定的页面信息，并返回实体主体。

 Post HTTP 1.0向指定资源提交数据进行处理请求（例如提交表单或者上传文件）。
数据被包含在请求体中。
POST请求可能会导致新的资源的建立和/或已有资源的修改。 
 Head HTTP 1.0

类似于get请求，只不过返回的响应中没有具体的内容，用于获取报头    

 Put HTTP 1.1

从客户端向服务器传送的数据取代指定的文档的内容。

 Delete HTTP 1.1

请求服务器删除指定的页面。

 Connect HTTP 1.1HTTP/1.1协议中预留给能够将连接改为管道方式的代理服务器。
 Options HTTP 1.1

这个方法可使服务器传回该资源所支持的所有HTTP请求方法。

允许客户端查看服务器的性能。

 Trace HTTP 1.1

回显服务器收到的请求，主要用于测试或诊断。

Rest和Restful API

（崩溃，都快写完了死机一下，又得从这里开始重写……）

Rest（Representational State Transfer，表述状态转移）在2000年Roy Fielding的博士论文《Architectural Styles and the Design of Network-based Software Architectures》中首次被提出，指的是一组架构约束条件和原则。符合这些约束条件和原则框架的API就是Restful API。

简单地总结这些约束条件和原则就是，URL定位资源，HTTP动词描述操作。

1、资源和表述

通常Web资源可以使用URI（Uniform Resource Identifier，统一资源标识符）来定位，URL是URI的一个子集，URL除了确定资源，还确定了访问方式（是用HTTP呢，FTP呢，还是LDAP呢），例如官方的例子，这些都是URI，但只有部分是URL：

 
  1. ftp://ftp.is.co.za/rfc/rfc1808.txt (also a URL because of the protocol)
  2. http://www.ietf.org/rfc/rfc2396.txt (also a URL because of the protocol)
  3. ldap://[2001:db8::7]/c=GB?objectClass?one (also a URL because of the protocol)
  4. mailto:John.Doe@example.com (also a URL because of the protocol)
  5. news:comp.infosystems.www.servers.unix (also a URL because of the protocol)
  6. tel:+1-816-555-1212
  7. telnet://192.0.2.16:80/ (also a URL because of the protocol)

Rest对资源的表述具体的约束：

（1）资源的格式

【只能使用名词，不能使用动词】

举个例子，通常的URL会这样设计：

 
  1. http://www.bewindoweb.com/getArticle?id=1

而Restful API是这样的：

 
  1. http://www.bewindoweb.com/articles/1

看起来更像是某个资源的位置了，而不管具体的访问方法。

【问号用来过滤】

还是那个例子，我们想要对文章内容分页获取，普通的设计：

 
  1. http://www.bewindoweb.com/getArticle?id=1&pageNo=1

而Restful API是这样的：

 
  1. http://www.bewindoweb.com/articles/1?pageNo=1

id并不使用问号，是因为它是资源定位的一部分；pageNo使用问号，是因为在对这个资源进行过滤操作，过滤可以包括pageNo、limit、state=0等等。

【单数和复数】

没有统一规定，但明显复数比单数好，例如articles/1比article/1更好，因为文章可能有很多篇。

【版本号】

可以在URL里面加入版本号，如：

 
  1. http://www.bewindoweb.com/v1/article/1

（2）统一的访问接口

Rest规定使用HTTP统一的Get、Post、Put、Patch、Delete来对资源进行访问。这里多了一个Patch，Patch是2010年RFC5789新增的HTTP请求方式，然而目前大多数容器都不支持，部分浏览器也不支持，HTML4只支持Get/Post，HTML5也增加了Put/Delete而已。所以对于Patch，在处理的时候需要去查询具体的解决方法。在讲述这些接口的作用前，了解两个概念：

【安全性（Safety）】

无论请求多少次，都不会改变服务器的状态。

例如，无论使用Get请求多少次文章，都不会改变文章具体的数据。

【幂等性（Idempotent）】

无论对资源操作多少次，结果总是一样的。

例如，采用PUT提交修改后的文章，无论操作多少次，修改后的文章内容都是一样的；而用POST让银行卡余额减少200，每次POST之后银行卡的余额都会发生变化。

所以，总结一下这5个请求方法：

请求方法 安全性 幂等性 作用
 Get安全幂等获取表示
变更时获取表示（缓存）
 Post不安全不幂等 服务端的实例号创建资源
创建子资源
 Put不安全幂等 客户端的实例号创建资源
替换的方式更新资源
 Patch不安全不幂等 部分更新资源
 Delete不安全幂等删除资源

根据服务端实例号创建资源：POST /items，服务端生成uuid。如果发生问题，服务端会重新生成uuid。

根据客户端实例号创建资源：PUT /items/31a1576d-7149-461a-a631-38bc11a5b2d3，利用幂等特性，无论出现什么问题，uuid不会变。

部分更新资源：Patch user/1 + 参数username=bwb，只需要携带一个参数即可，不需要全部的user属性。

（3）多种表现形式

客户端根据Accept、服务端根据Content-Type来进行协商，可以使用XML、Json等等很多表现形式。

2、资源的链接

资源之间需要链接起来，那么就要求表述格式里面加入链接来引导客户端，例如：

【请求】

 
  1. GET https://api.bewindoweb.com/articles/1 HTTP/1.1
  2. Accept: application/json

【响应】

 
  1. HTTP/1.1 Status: 200 OK
  2. Link: <https://api.bewindowb.com/articles/1?page=2>; rel="next",
  3. <https://api.bewindoweb.com/articles/1?page=3>; rel="last"
  4. Content-Type:application/json; charset=utf-8
  5. [
  6. {
  7. .....
  8. }
  9. ]

响应头里面包含了如何访问下一页和尾页的链接。

3、状态和转移

Rest是无状态通信的，每一次请求都看作是全新的请求，是不会存在JSESSIONID这样的Cookie的。服务端只维护资源状态，并不关心客户端的状态（不会保存session）；客户端才维护应用状态，所以状态转移指的是客户端的状态转移。

举个例子，如果你想要查询工资，那么你需要经过登录→工资界面→工资数据，这是普通的Session的有状态通信；如果你输入一个URL立刻得到了工资数据，这就是符合Rest要求的架构。

很明显可以看出一个问题是，资源的安全性应该如何保障？目前通用的做法是JWT（JSON Web Token）进行认证和授权。

4、状态码

Rest要求返回具体的状态码，而不是出错返回200，然后再在Json里面描述出错信息。简单列举一些状态码：

状态码 描述 
 200  操作完成（更新成功、删除成功）
 201 新资源被创建
 204 资源为空
 304 没有变化，客户端可以使用缓存
 400 非法调用（参数错误）
 401 未认证
 403 不允许访问
 404 资源不存在
 500 通用错误
 503 服务器当前无法处理请求

 

总结

Restful API非常适合于分布式服务器提供接口服务，认证逻辑简单，资源控制清晰，可以跨域等等，不需要保存任何会话数据，值得实践。

 

 写得很赞  微博收藏  打赏作者

转载请注明出处：http://www.bewindoweb.com/221.html | 三颗豆子
分享许可方式：知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议
重大发现：转载注明原文网址的同学刚买了彩票就中奖，刚写完代码就跑通，刚转身就遇到了真爱。

 你可能还会喜欢

长连接波动队列暴增与连接量限制排查2020年11月01日

 

JWT的签名算法选择研究2020年10月28日

 

kafka原理和源码（四）：V0、V1、V2消息格式2020年09月18日

 具体问题具体杠

 

 

© 2017-2018 BEWINDOWEB bwbUI2.0黑ICP备17001360号   发送邮件  github  个人wiki

风流倜傥唐伯虎
关注
  • 3
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
API RESTful:PHP / MySQL中的RESTful API，可适应提供的内容-开源
05-27
RESTful API是用PHP编写的，并且基于MySQL数据库。 它可以处理任何类型的内容，可以消化它并适应您提供的任何内容。 进行身份验证，或：-通过api_key-通过GET用户和密码-通过Apache身份验证第一个版本接受POST，GET，PUT，DELETE此API具有EDIT_MODE：在POST或PUT期间，表适用于所提供的内容：-如果内容类型是新的，它将创建一个表-如果内容具有新的列，则将调整该表。搜索功能有：全局，按列，有序等。此RESTful API受禁止系统保护，对于那些不喜欢的人知道如何实现它。 禁止的错误数是20错误/ 24小时。 如果要绕过功能，只需根据提供的接口实现一个新类。 使用情况会收集到数据库中，以进行进一步的统计，系统收集位置和ISP信息。这里有一个示例目录来学习如何使用它。 ＃参见Doc的Wiki !!
restfulApi相关
dw5235的博客
03-27 222
RESTful是目前最流行的 API 设计规范，用于 Web 数据接口的设计。 它的大原则容易把握，但是细节不容易做对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。 一、URL 设计 1.1 动词 + 宾语 RESTful 的核心思想就是，客户端发出的数据操作指令都是"动词 + 宾语"的结构。比如，GET /articles这个命令，GET是动词，/...
【HTTP完全注释】爆肝万字！让你全面了解HTTP发展史！！！
最新发布
汪啊汪
03-07 1015
HTTP的历史​ 超文本传输协议（英语：HyperText Transfer Protocol，缩写：HTTP）是万维网（World Wide Web）的基础协议。自蒂姆·伯纳斯-李 （Tim BernersLee）博士和他的团队在 1989-1991 年间创造出它以来，HTTP 已经发生了太多的变化，在保持协议简单性的同时，不断扩展其灵活性。如今，HTTP 已经从一个只在实验室之间交换文档的早期协议进化到了可以传输图片，高分辨率视频和 3D 效果的现代复杂互联网协议。 HTT
Java+Maven+TestNG接口(API)自动化测试教程(八) Post,Put 和 Delete 方法
renxingzhadan的专栏
07-28 748
8.1 发送 POST 方法 post 方法和 get 方法是我们在做接口测试时，用的最多的两个请求方法。 在发送请求时它们显著的一个差别就在于，get 方法我们只需要将 url 发送即可，post 我们还需发送一个请求主体；在作用方面，get 方法用于查询，不会改变服务器中的信息；而 Post 方法可用于修改服务器中的信息。 8.1.1 修改 HttpClientUtil 实现发送 POST 请求和获取响应 根据请求的数据是 JSON 对象还是表单形式的键值对，分成了...
普歌 -智音团队 Vue用element-ui调用后端API实现删除功能
weixin_45498167的博客
09-17 1181
调用后端接口实现删除功能 1.一般根据id删除 //先把id传入 deletebanner(id) { return request({ url: `地址 `, method: "delete", }) }, 2.用自定义插槽做删除按钮 </el-table-column> <template slot-scope="scope"> <el-button size="mini" type
删除方法:Delete API-Medoo使用指南
weixin_34332905的博客
05-25 166
上一篇《更新方法:Update API-Medoo使用指南》中介绍...
delete 接口
一线大码
09-07 2136
文章目录DeleteRequest可选参数同步执行异步执行DeleteResponse 官方文档地址：Delete API DeleteRequest DeleteRequest有两个必需参数： DeleteRequest deleteRequest = new DeleteRequest( "posts", //索引 "1");//文档ID 可选参数 可以提供以下参数： //路由值 deleteRequest.routing("routing"); ////使用Tim
接口请求GET，POST，PUT，DELETE简述
fanger0705的博客
01-12 444
3、Put 向指定资源位置上上传其最新内容（从客户端向服务器传送的数据取代指定文档的内容），相当于Update，不会有新的资源的建立。2、Post 向指定资源提交数据进行处理请求（提交表单、上传文件），又可能导致新的资源的建立或原有资源的修改。1、Get 向特定资源发出请求（请求指定页面信息，并返回body主体）4、Delete 请求服务器删除request-URL所标示的资源。
“一把梭：REST API 全用 POST” restful api post、get 、put 、delete选择
qq_31686241的博客
09-11 2482
restful api post、get 、put 、delete选择
只用Get Post放弃 PUT DELETE
追求卓越，成功就在不经意间追上你
01-11 1042
首先我不否认Restful风格的优雅，谁不想让自己的代码优雅。 但是如果优雅变的复杂，那么我宁愿选择简单。 restful风格如下 POST .../user DELETE .../user/{resourceId} GET .../user/{resourceId} PUT .../user/{resourceId} 非restful风格如下 POST
restful api接口规范_Restful API设计规范
weixin_39655993的博客
11-22 286
RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。RESTFUL特点包括：1、每一个URI代表1种资源；2、客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GE...
RESTful-API-demo:RESTful API演示
05-02
使用express,MongoDb快速构建Node.js REST API () REST API解决了什么问题（能干什么？） 网络应用-重前端轻后端模式，后端专注于业务，提供前端数据接口。一套API给多客户端提供服务 Resetful API-设计更加规范的...
api：RESTful API倒入应用程序VigilateEtOrate
02-20
使用ExpressJS和MongoDB的TypeScript中的模板RESTful API终点端点名称方法描述/我POST，GET，Patch，PUT，DELETE 当前用户相关/登记邮政注册新用户/登录邮政登录用户/社会的邮政使用社交令牌注册/登录特征宁静的打字...
wrapi:将Restful API包装为可调用函数
05-28
包装纸 将Restful API端点包装为可调用函数。 在3分钟内创建一个Rest API SDK。 使用wrapi您可以像普通JavaScript函数一样对基于HTTP... "path" : "relative/path/to/:api/endpoint" // Use `express` style path par
sleepy-movies:使用 go-restful 构建 RESTful API 的技术演示
06-10
PUT /movies/:id创建/更新具有给定 ID 的电影。 DELETE /movies/:id按 ID 删除电影。 GET /genre返回所有流派。 流派有名称。 POST /genre创建一个新的流派。 GET /genre/:id返回指定的流派。 PUT /genre/:id创建/...
node-express-restful-api:使用Node和Express的RESTful API
05-10
使用Node和Express的RESTful API 这是我们将需要的路由，它们将执行的操作以及用于访问它的HTTP Verb的概述。 Route HTTP Verb Description /api/beers GET Get all the beers. /api/beers POST Create a beer. /...
symfony-restful-api：Symfony 4中的REST API
02-06
Rest Api Symfony应用程序 ======================== 要求 PHP 7.1.3或更高版本； 已启用PDO-pgSQL PHP扩展； Redis; 和[通常的Symfony应用要求] [1]。 安装 执行以下命令以安装项目： $ git clone git@github....
yarmk：Koa的另一个Restful API中间件
02-03
Koa的另一个Restful ... 删除：DELETE / user /：id 动作：PUT / user /：id 因此，我们将此作为设计REST API的默认规则。 控制者 每个端点都是一个JS模块，例如用户： module . exports = { list ( ctx ) { ctx
RESTful-Unity：RESTful-Unity旨在为Unity3d提供一个简单的RESTful HTTP服务器
02-05
RESTful统一 RESTful-Unity旨在为提供一个简单的RESTful HTTP服务器。 通过http请求从Unity场景访问并封装游戏对象的状态。 这个项目是在3D原型制作原型期间创建的，其中可以通过访问和控制游戏对象。 这是概念验证...
Django框架restful序列化get/post/delete/put请求接口设计(高级版)
05-16
在设计Django框架的RESTful API接口时，我们需要考虑以下几个方面： 1. URL设计 2. 请求方法的选择 3. 数据的序列化和反序列化 4. 异常处理 下面我们将逐一介绍这些方面的设计。 1. URL设计 RESTful API接口的URL设计应该遵循一定的规范。一般而言，我们可以将URL按照以下的方式进行设计： ``` http(s)://host:port/api/{version}/{resource}/{resource_id}/ ``` 其中，`version`表示API版本，`resource`表示资源，`resource_id`表示资源的唯一标识符。例如： ``` http://localhost:8000/api/v1/users/1/ ``` 表示获取ID为1的用户信息。 2. 请求方法的选择 RESTful API接口支持以下四种请求方法： - GET：获取资源 - POST：创建资源 - PUT：更新资源 - DELETE：删除资源 这四种请求方法对应着CRUD操作中的"读取"、"创建"、"更新"和"删除"。 3. 数据的序列化和反序列化 在RESTful API中，数据的序列化和反序列化是非常重要的。序列化是将Python对象转换为JSON或XML等格式的过程，而反序列化则是将JSON或XML等格式的数据转换为Python对象的过程。 Django框架提供了一些强大的序列化工具，例如`django-rest-framework`。我们可以使用这些工具来实现数据的序列化和反序列化。 4. 异常处理 在RESTful API接口的设计中，异常处理也是非常重要的。我们需要对可能出现的异常进行处理，并返回适当的错误信息。 在Django框架中，我们可以使用`try...except`语句来捕获异常，并使用`HttpResponse`对象返回错误信息。例如： ```python from django.http import HttpResponse def my_view(request): try: # some code here except: return HttpResponse('Error occurred', status=500) ``` 以上是Django框架RESTful API接口设计的基本要素，通过合理的设计可以实现一个高效、易用的API接口。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值