RESTful API的HTTP方法详解 (restful)

RESTfulAPI的HTTP方法详解

一、引言

随着互联网的快速发展，RESTful API已成为Web服务的重要标准之一。
RESTful API基于HTTP协议，使用客户端/服务器模式，通过不同的HTTP方法实现数据的增删改查等操作。
本文将详细介绍RESTful API中常用的HTTP方法，包括GET、POST、PUT、DELETE、HEAD、OPTIONS等，帮助读者更好地理解RESTful API的基本原理和实际操作。

二、GET方法

1. 作用：获取资源。
2. 示例：获取所有用户信息、获取指定用户信息等。
3. 特点：
（1）安全性较高，不会修改服务器数据；
（2）参数通常放在URL中，可通过浏览器直接访问；
（3）有缓存机制，可提高访问速度。

三、POST方法

1. 作用：添加资源。在指定的资源路径下创建新数据。
2. 示例：创建新用户、提交评论等。
3. 特点：
（1）需要提交数据到服务器进行处理；
（2）无缓存，每次请求都需要进行处理；
（3）表单数据、JSON数据等可通过POST方法提交。

四、PUT方法

1. 作用：更新资源。将客户端的数据更新到服务器，覆盖原有数据。
2. 示例：更新用户信息、更新文章等。
3. 特点：
（1）需提交完整的数据进行更新；
（2）如果部分数据不需要更新，不能使用PUT方法；
（3）通常用于资源被完整传输时。例如，当需要将整个实体从一个API版本升级到另一个版本时，可以使用PUT方法将整个实体发送给API端点以更新其状态。这种方式类似于“补丁”或“替换”操作，因为它会替换目标资源当前存储的任何版本。由于PUT请求可能会覆盖目标资源的所有现有内容，因此它们通常用于更新大型数据集或复杂的资源结构。请注意，由于PUT请求可能产生显著的服务端负载，因此在处理大量并发更新时可能会对性能产生影响。在资源访问控制方面，开发者需要确保只有授权的用户才能执行PUT操作，以防止未经授权的修改和数据泄露风险。同时，在设计API时，需要仔细考虑PUT请求的具体用途和场景，以确保用户体验和安全性达到最佳平衡。然而在某些情况下可能会产生冲突问题例如在并发更新的情况下不同客户端可能尝试同时修改同一资源由于某些原因产生数据不一致此时可以使用乐观锁定机制通过版本号时间戳等方式来避免冲突的发生确保数据的准确性和一致性总之在使用PUT方法时开发者应该谨慎处理这些问题以确保系统的稳定性和可靠性此外还有一些开发人员使用PATCH方法来执行部分更新这在处理大型资源或避免客户端不必要的开销方面可能是有益的但是需要注意它可能会导致接口更加复杂和难以维护这就需要开发人员根据实际情况和需求来权衡利弊选择最合适的解决方案以确保系统满足实际需求并保持良好的用户体验总结RESTful API中的HTTP方法包括GETPOSTPUTDELETEHEADOPTIONS等每种方法都有其特定的用途和特点在实际应用中需要根据需求选择合适的HTTP方法以实现数据的增删改查等操作同时还需要注意安全性和性能问题以确保系统的稳定性和可靠性在实际开发中应该根据实际情况和需求选择合适的解决方案以提高系统的效率和用户体验三关于PUT的使用以及注意事项三十二条解答完毕重述这个段落主要是对PUT方法的进一步说明和解述包括对并发更新的冲突问题乐观锁定机制的使用以及一些开发中的权衡取舍问题整体上对RESTful API的HTTP方法提供了更深入的理解指导读者在实际应用中如何更好地运用这些方法需要注意的是虽然RESTful API提供了灵活的数据交互方式但也需要注意安全性和性能问题确保系统的稳定性和可靠性重述这段文字后我们可以看到它对RESTful API的使用给出了更为详细的指导和实践建议为读者提供了更深入的理解和实际操作的经验分享总的来说对于开发者来说掌握RESTful API的HTTP方法是非常重要的这不仅能够帮助他们更好地设计和实现Web服务还能提高系统的效率和用户体验因此在日常开发中应加强对这些方法的掌握和运用以期为项目开发带来更大的价值在本文最后我们还需强调一点尽管本文对RESTful API的HTTP方法进行了详细的介绍但这并不意味着只有一种绝对正确的方式在实际开发中需要根据项目的具体情况和需求灵活运用各种方法以达到最佳的效果因此开发者需要具备丰富的实践经验和灵活的思维方式以应对各种复杂情况的发生确保项目的顺利进行总之对于开发者来说掌握RESTful API的HTTP方法是提升项目开发效率和用户体验的关键需要不断学习和实践以提高自身的技能水平

什么是REST API

Rest API 开发学习笔记概述REST 从资源的角度来观察整个网络，分布在各处的资源由URI确定，而客户端的应用通过URI来获取资源的表示方式。获得这些表徵致使这些应用程序转变了其状态。随着不断获取资源的表示方式，客户端应用不断地在转变着其状态，所谓表述性状态转移（Representational State Transfer）。这一观点不是凭空臆造的，而是通过观察当前Web互联网的运作方式而抽象出来的。 Roy Fielding 认为，“设计良好的网络应用表现为一系列的网页，这些网页可以看作的虚拟的状态机，用户选择这些链接导致下一网页传输到用户端展现给使用的人，而这正代表了状态的转变。 ”REST是设计风格而不是标准。 REST通常基于使用HTTP，URI，和XML以及HTML这些现有的广泛流行的协议和标准。资源是由URI来指定。对资源的操作包括获取、创建、修改和删除资源，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。通过操作资源的表现形式来操作资源。资源的表现形式则是XML或者HTML，取决于读者是机器还是人，是消费web服务的客户软件还是web浏览器。当然也可以是任何其他的格式。 REST的要求客户端和服务器结构连接协议具有无状态性能够利用Cache机制增进性能层次化的系统随需代码 - Javascript （可选）RESTful Web 服务RESTful Web 服务（也称为 RESTful Web API）是一个使用HTTP并遵循REST原则的Web服务。它从以下三个方面资源进行定义：URI，比如：。 § Web服务接受与返回的互联网媒体类型，比如：JSON，XML ，YAML 等。 § Web服务在该资源上所支持的一系列请求方法（比如：POST，GET，PUT或DELETE）。该表列出了在实现RESTful Web 服务时HTTP请求方法的典型用途。 HTTP 请求方法在RESTful Web 服务中的典型应用资源GETPUTPOSTDELETE一组资源的URI，比如列出 URI，以及该资源组中每个资源的详细信息（后者可选）。使用给定的一组资源替换当前整组资源。在本组资源中创建/追加一个新的资源。该操作往往返回新资源的URL。删除整组资源。单个资源的URI，比如获取指定的资源的详细信息，格式可以自选一个合适的网络媒体类型（比如：XML、JSON等）替换/创建指定的资源。并将其追加到相应的资源组中。把指定的资源当做一个资源组，并在其下创建/追加一个新的元素，使其隶属于当前资源。删除指定的元素。 PUT 和 DELETE 方法是幂等方法。 GET方法是安全方法（不会对服务器端有修改，因此也是幂等的）。不像基于SOAP的Web服务，RESTful Web服务并没有的“正式”标准。这是因为REST是一种架构，而SOAP只是一个协议。虽然REST不是一个标准，但在实现RESTful Web服务时可以使用其他各种标准（比如HTTP，URL，XML，PNG等）。 REST的优点可以利用缓存Cache来提高响应速度通讯本身的无状态性可以让不同的服务器的处理一系列请求中的不同请求，提高服务器的扩展性浏览器即可作为客户端，简化软件需求相对于其他叠加在HTTP协议之上的机制，REST的软件依赖性更小不需要额外的资源发现机制在软件技术演进中的长期的兼容性更好可以看一下）

怎样用通俗的语言解释REST，以及RESTful

0. REST不是rest这个单词，而是几个单词缩写。但即使那几个单词说出来，也无法理解在说什么 -_-!! （不是要贬低人，是我自己也理解困难）；1. REST描述的是在网络中client和server的一种交互形式；REST本身不实用，实用的是如何设计 RESTful API（REST风格的网络接口）；2. Server提供的RESTful API中，URL中只使用名词来指定资源，原则上不使用动词。 “资源”是REST架构或者说整个网络处理的核心

怎样用通俗的语言解释什么叫 REST，以及什么是 RESTful

REST (REpresentation State Transfer) 描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，他是 HTTP 规范的主要编写者之一。 REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。 Web 应用程序最重要的 REST 原则是，客户端和服务器之间的交互在请求之间是无状态的。从客户端到服务器的每个请求都必须包含理解请求所必需的信息。如果服务器在请求之间的任何时间点重启，客户端不会得到通知。此外，无状态请求可以由任何可用服务器回答，这十分适合云计算之类的环境。客户端可以缓存数据以改进性能。在服务器端，应用程序状态和功能可以分为各种资源。资源是一个有趣的概念实体，它向客户端公开。资源的例子有：应用程序对象、数据库记录、算法等等。每个资源都使用 URI (Universal Resource Identifier) 得到一个惟一的地址。所有资源都共享统一的界面，以便在客户端和服务器之间传输状态。使用的是标准的 HTTP 方法，比如 GET、PUT、POST 和 DELETE。 Hypermedia 是应用程序状态的引擎，资源表示通过超链接互联。另一个重要的 REST 原则是分层系统，这表示组件无法了解它与之交互的中间层以外的组件。通过将系统知识限制在单个层，可以限制整个系统的复杂性，促进了底层的独立性。当REST 架构的约束条件作为一个整体应用时，将生成一个可以扩展到大量客户端的应用程序。它还降低了客户端和服务器之间的交互延迟。统一界面简化了整个系统架构，改进了子系统之间交互的可见性。 REST 简化了客户端和服务器的实现。 RESTful的实现：RESTful Web 服务与 RPC 样式的 Web 服务了解了什么是什么是REST，我们再看看RESTful的实现。最近，使用 RPC 样式架构构建的基于 SOAP 的 Web 服务成为实现 SOA 最常用的方法。 RPC 样式的 Web 服务客户端将一个装满数据的信封（包括方法和参数信息）通过 HTTP 发送到服务器。服务器打开信封并使用传入参数执行指定的方法。方法的结果打包到一个信封并作为响应发回客户端。客户端收到响应并打开信封。每个对象都有自己独特的方法以及仅公开一个 URI 的 RPC 样式 Web 服务，URI 表示单个端点。它忽略 HTTP 的大部分特性且仅支持 POST 方法。由于轻量级以及通过 HTTP 直接传输数据的特性，Web 服务的 RESTful 方法已经成为最常见的替代方法。可以使用各种语言（比如 Java 程序、Perl、Ruby、Python、PHP 和 Javascript[包括 Ajax]）实现客户端。 RESTful Web 服务通常可以通过自动客户端或代表用户的应用程序访问。但是，这种服务的简便性让用户能够与之直接交互，使用它们的 Web 浏览器构建一个 GET URL 并读取返回的内容。在REST 样式的 Web 服务中，每个资源都有一个地址。资源本身都是方法调用的目标，方法列表对所有资源都是一样的。这些方法都是标准方法，包括 HTTP GET、POST、PUT、DELETE，还可能包括 HEADER 和 OPTIONS。在RPC 样式的架构中，关注点在于方法，而在 REST 样式的架构中，关注点在于资源 —— 将使用标准方法检索并操作信息片段（使用表示的形式）。资源表示形式在表示形式中使用超链接互联。 Leonard Richardson 和 Sam Ruby 在他们的著作 RESTful Web Services 中引入了术语 REST-RPC 混合架构。 REST-RPC 混合 Web 服务不使用信封包装方法、参数和数据，而是直接通过 HTTP 传输数据，这与 REST 样式的 Web 服务是类似的。但是它不使用标准的 HTTP 方法操作资源。它在 HTTP 请求的 URI 部分存储方法信息。好几个知名的 Web 服务，比如 Yahoo 的 Flickr API 和 API 都使用这种混合架构。 RESTful的实现：RESTful Web 服务的 Java 框架有两个 Java 框架可以帮助构建 RESTful Web 服务。 erome Louvel 和 Dave Pawson 开发的 Restlet（见参考资料）是轻量级的。它实现针对各种 RESTful 系统的资源、表示、连接器和媒体类型之类的概念，包括 Web 服务。在 Restlet 框架中，客户端和服务器都是组件。组件通过连接器互相通信。该框架最重要的类是抽象类 Uniform 及其具体的子类 Restlet，该类的子类是专用类，比如 Application、Filter、Finder、Router 和 Route。这些子类能够一起处理验证、过滤、安全、数据转换以及将传入请求路由到相应资源等操作。 Resource 类生成客户端的表示形式。 JSR-311是 Sun Microsystems 的规范，可以为开发 RESTful Web 服务定义一组 Java API。 Jersey是对 JSR-311 的参考实现。 JSR-311 提供一组注e68a84e799bee5baa3062释，相关类和接口都可以用来将 Java 对象作为 Web 资源展示。该规范假定 HTTP 是底层网络协议。它使用注释提供 URI 和相应资源类之间的清晰映射，以及 HTTP 方法与 Java 对象方法之间的映射。 API 支持广泛的 HTTP 实体内容类型，包括 HTML、XML、JSON、GIF、JPG 等。它还将提供所需的插件功能，以允许使用标准方法通过应用程序添加其他类型。 RESTful的实现：构建 RESTful Web 服务的多层架构RESTful Web 服务和动态 Web 应用程序在许多方面都是类似的。有时它们提供相同或非常类似的数据和函数，尽管客户端的种类不同。例如，在线电子商务分类网站为用户提供一个浏览器界面，用于搜索、查看和订购产品。如果还提供 Web 服务供公司、零售商甚至个人能够自动订购产品，它将非常有用。与大部分动态 Web 应用程序一样，Web 服务可以从多层架构的关注点分离中受益。业务逻辑和数据可以由自动客户端和 GUI 客户端共享。惟一的不同点在于客户端的本质和中间层的表示层。此外，从数据访问中分离业务逻辑可实现数据库独立性，并为各种类型的数据存储提供插件能力。图1 展示了自动化客户端，包括 Java 和各种语言编写的脚本，这些语言包括 Python、Perl、Ruby、PHP 或命令行工具，比如 curl。在浏览器中运行且作为 RESTful Web 服务消费者运行的 Ajax、Flash、JavaFX、GWT、博客和 wiki 都属于此列，因为它们都代表用户以自动化样式运行。自动化 Web 服务客户端在 Web 层向 Resource Request Handler 发送 HTTP 响应。客户端的无状态请求在头部包含方法信息，即 POST、GET、PUT 和 DELETE，这又将映射到 Resource Request Handler 中资源的相应操作。每个请求都包含所有必需的信息，包括 Resource Request Handler 用来处理请求的凭据。从Web 服务客户端收到请求之后，Resource Request Handler 从业务逻辑层请求服务。 Resource Request Handler 确定所有概念性的实体，系统将这些实体作为资源公开，并为每个资源分配一个惟一的 URI。但是，概念性的实体在该层是不存在的。它们存在于业务逻辑层。可以使用 Jersey 或其他框架（比如 Restlet）实现 Resource Request Handler，它应该是轻量级的，将大量职责工作委托给业务层。 Ajax 和 RESTful Web 服务本质上是互为补充的。它们都可以利用大量 Web 技术和标准，比如 HTML、JavaScript、浏览器对象、XML/JSON 和 HTTP。当然也不需要购买、安装或配置任何主要组件来支持 Ajax 前端和 RESTful Web 服务之间的交互。 RESTful Web 服务为 Ajax 提供了非常简单的 API 来处理服务器上资源之间的交互。图1 中的 Web 浏览器客户端作为 GUI 的前端，使用表示层中的 Browser Request Handler 生成的 HTML 提供显示功能。 Browser Requester Handler 可以使用 MVC 模型（JSF、Struts 或 Spring 都是 Java 的例子）。它从浏览器接受请求，从业务逻辑层请求服务，生成表示并对浏览器做出响应。表示供用户在浏览器中显示使用。表示不仅包含内容，还包含显示的属性，比如 HTML 和 CSS。业务规则可以集中到业务逻辑层，该层充当表示层和数据访问层之间的数据交换的中间层。数据以域对象或值对象的形式提供给表示层。从业务逻辑层中解耦 Browser Request Handler 和 Resource Request Handler 有助于促进代码重用，并能实现灵活和可扩展的架构。此外，由于将来可以使用新的 REST 和 MVC 框架，实现它们变得更加容易，无需重写业务逻辑层。数据访问层提供与数据存储层的交互，可以使用 DAO 设计模式或者对象-关系映射解决方案（如 Hibernate、OJB 或 iBATIS）实现。作为替代方案，业务层和数据访问层中的组件可以实现为 EJB 组件，并取得 EJB 容器的支持，该容器可以为组件生命周期提供便利，管理持久性、事务和资源配置。但是，这需要一个遵从 Java EE 的应用服务器（比如 JBoss），并且可能无法处理 Tomcat。该层的作用在于针对不同的数据存储技术，从业务逻辑中分离数据访问代码。数据访问层还可以作为连接其他系统的集成点，可以成为其他 Web 服务的客户端。数据存储层包括数据库系统、LDAP 服务器、文件系统和企业信息系统（包括遗留系统、事务处理系统和企业资源规划系统）。使用该架构，您可以开始看到 RESTful Web 服务的力量，它可以灵活地成为任何企业数据存储的统一 API，从而向以用户为中心的 Web 应用程序公开垂直数据，并自动化批量报告脚本。什么是REST：结束语REST 描述了一个架构样式的互联系统（如 Web 应用程序）。 REST 约束条件作为一个整体应用时，将生成一个简单、可扩展、有效、安全、可靠的架构。由于它简便、轻量级以及通过 HTTP 直接传输数据的特性，RESTful Web 服务成为基于 SOAP 服务的一个最有前途的替代方案。用于 web 服务和动态 Web 应用程序的多层架构可以实现可重用性、简单性、可扩展性和组件可响应性的清晰分离。 Ajax 和 RESTful Web 服务本质上是互为补充的。