# PATH 部分，REST API 的标准最佳实践是使用连字符（hyphen），而不是下划线（underscore）或驼峰（camelcase）。.../users/john_doe 虽然两者在技术上都是有效的 URL，但前者更符合 REST API 的最佳实践。...first-name=john&last-name=doe 虽然在技术上两者都是有效的，但使用下划线的查询参数更符合 REST API 的最佳实践，并且更容易读写和阅读。...推荐使用第一种方式，使用 DELETE 方法，多个资源 ID 放进 URL Query 中。就像我们使用 GET 请求多个资源时，将筛选条件放到 Query 参数中。...删除多个评论 5.小结 在这篇文章中，你了解了在创建 REST API 时需要记住的几个最佳实践。
每个资源都由一个 URI（统一资源标识符）唯一标识。 客户端-服务器：REST 将负责存储和发送信息的服务器与负责获取信息和适当使用信息的客户端分开。这种分离使双方更加独立和可扩展。...例如，如果客户端请求访问受限资源，则客户端必须在每次请求时将其身份验证令牌发送到服务器。 可缓存：REST 中的客户端和服务器都可以缓存资源，有助于减少流量并提高性能。...OData vs REST: What is OData? 根据 OData 网站的说法，OData（开放数据协议）“定义了一组用于构建和使用 RESTful API 的最佳实践。...最后，OData 包括有关如何执行操作（例如跟踪更改、定义可重用程序和发送多个（批处理）REST 请求）的指南。...OData 构建在 REST 框架之上，以定义构建 REST API 的最佳实践，包括 HTTP 消息格式、如何查询 API 等。
原文：10 Best Practices for Writing Node.js REST APIs 我们会通过本文介绍下书写Node.js REST API的最佳实践，包括各个主题，像是命名路由、认证...这些操作HTTP已经有可以胜任的工具集：POST,PUT, GET, PATCH 或 DELETE。 作为最佳实践，你的API路由应该一直使用名词作为资源id。...涉及到用的资源相关的，路由机制也可以这样： POST /user 或者 PUT /user:/id 来创建新用户 GET /user 来获取列表的用户 GET /user/:id 来获得某一个用户 PATCH...像这样的头可以是在如下信息的上： 页码 速率限制 或者是认证. 标准化HTTP头的列表可以在 这里 被找到。 如果你需要在你的相应头里面设置任何自定义的metadata，给它们加上X前缀是最佳实践。...接下篇《十个书写Node.js REST API的最佳实践（下）》
在今天的开发环境中，RESTful API仍然是服务和消费数据的最佳选择之一。 但你是否考虑过学习行业标准？设计一个RESTful API的最佳实践是什么？...我们将探索构建RESTful API时应该考虑的13个最佳实践。 最佳实践 本文为你提供了13个可操作的最佳实践清单。让我们一起来探索吧！...RESTful API的最佳实践描述了一个端点应该以资源名称开始，而HTTP的操作则描述了行为。...有意义的错误处理 万一出了问题，向开发者提供一个有意义的错误信息是很重要的。...头发送元数据 速率限制 有意义的错误处理 选择正确的API框架 输出文档 保持简洁 如果你喜欢这篇有关API最佳实践的文章，你可能也会喜欢学习从头开始建立一个RESTful API[8]。
我第一次如此强烈得感受到 REST 接口的美妙，完全满足了我所期待的「接口的形式美感」，简直就是对 REST 规范实现的最佳范本。...REST 描述了 HTTP 层里客户端和服务器端的数据交互规则；客户端通过向服务器端发送 HTTP（s）请求，接收服务器的响应，完成一次 HTTP 交互。...在 REST 架构的链接应该是这个样子： URL 中不应该出现任何表示操作的动词，链接只用于对应资源； URL 中应该单复数区分，推荐的实践是永远只用复数；比如 GET /api/users 表示获取用户的列表...PATCH 的作用在于如果一个资源有很多字段，在进行局部更新时，只需要传入需要修改的字段即可。否则在用 PUT 的情况下，你不得不将整个资源模型全都发送回服务器，造成网络资源的极大浪费。...三、分页、过滤 REST 风格的接口地址，表示的可能是单个资源，也可能是资源的集合；当我们需要访问资源集合时，设计良好的接口应当接受参数，允许只返回满足某些特定条件的资源列表。
JSON响应是机器可读的，因此可以在输出HTML或其他格式之前被进行解析和使用。 REST APIs和Rest 多年来，各种数据通信标准已经发展起来。...要深入了解实现策略，请看13个构建RESTful API的最佳实践[14]。 端点共识 考虑下面的端点： /user/123 /user/id/123 /user/?...在发出任何请求之前，通过向OAuth服务器发送一个客户ID和可能的客户秘密，获得一个令牌。然后，OAuth令牌会随每个API请求一起发送，直到过期。...即使它不是一个引人注目的黑客目标，一个行为不良的客户端也可能每秒发送数以千计的请求，并使你的服务器崩溃。 安全性超出了本文的范围，但常见的最佳实践包括： 使用HTTPS。 使用健壮的身份验证方法。...下一篇文章中，会翻译分享13个构建RESTful API的最佳实践[27]，欢迎关注。
与需要解析和路由每个请求以在本地Web服务上运行的SOAP不同，REST利用标准HTTP请求，并且不需要重新打包数据。...分布式拒绝服务（DDOS） 在分布式拒绝服务（DDoS）攻击中，多个系统会淹没目标系统（通常是一个或多个Web服务器）的带宽或资源。...例如，2017年初在FCC网站上发生的DDoS攻击使用商业云服务向评论系统发出大量API请求。这消耗了可用的机器资源并挤出了人类评论者，最终导致网站崩溃。...API安全最佳实践 针对上述攻击保护您的API应基于： 认证 - 确定最终用户的身份。...其他最佳实践包括根据API架构验证您的API调用，这些API架构清楚地描述了预期的结构。扫描有效载荷并执行模式验证可以防止代码注入，恶意实体声明和解析器攻击。
尽可能地遵循行业普遍接受的 REST/HTTP 最佳实践。 让所有应用开发者都可以轻松的通过REST接口访问Micosoft服务。...客户端指导 为确保客户端更好的接入REST服务，客户端应遵循以下最佳实践: 6.1 忽略规则 对于松散耦合的客户端调用，在调用之前不知道数据的确切定义和格式，如果服务器没用返回客户端预期的内容，客户端必须安全地忽略它...服务端可以选择性的忽略，如客户端发送多个Accept标头，服务可以选择其中一个格式进行响应。...Authorization标头不是简单集的一部分，因此对于需要验证的资源，必须通过“access_token”查询参数发送验证令牌。...Changing collections POST请求不是幂等的。 这意味着发送到具有完全相同的有效负载(payload)的集合资源的两次POST请求可能导致在该集合中创建多个项。
在开发实践中我们很多人可能还是使用传统API进行请求交互，很多人其实并不特别了解RESTful API，对RESTful API的认知可能会停留在： 面向资源类型的 是一种风格 (误区)接口传递参数使用斜杠...当客户端可以切换到一个新状态的时候发送请求信息， 当一个或者多个请求被发送之后, 客户端就处于一个状态变迁过程中。每一个应用的状态描述可以被客户端用来初始化下一次的状态变迁。...: 访问资源的路径，就是各种web 框架中定义的route路由 query: 查询字符串，为发送给服务器的参数，在这里更多发送数据分页、排序等参数。...GET POST PUT DELETE请求 GET请求用来获取资源：GET请求会向数据库发索取数据的请求，从而来获取资源，该请求就像数据库的select操作一样，只是用来查询数据，不会影响资源的内容。...POST请求用来新增一个资源 : POST请求向服务器发送数据，但是该请求会改变数据的内容(新添)，就像数据库的insert操作一样，会创建新的内容。
因为按照RESTful架构可以充分的利用HTTP协议带给我们的各种功能，算是对HTTP协议使用的最佳实践，还有一点就是可以使软件架构设计更加清晰，可维护性更好，但是并不是所有情况都需要完全遵守REST原则...例子：在HTTP中使用GET方法通常用于从服务器获取资源，无论调用多少次产生的额外效果都是从服务器获取资源，所以GET具有幂等性；而POST方法通常用于提交数据在服务器上创建一个资源，由于最终创建的结果每次都是不同的...安全方法：安全方法是指不修改资源的 HTTP 方法。譬如，当使用 GET 或者 HEAD 作为资源 URL，都必须不去改变资源。然而，这并不全准确。意思是：它不改变资源的 表示形式。...Request：通过标准HTTP方法对资源CRUD GET：查询资源 GET /comments //获取所有评论 GET /comments/tid/1 //获取文章tid为1的所有评论 POST:创建资源...支持JSONP的API可能需要第三种方法来实现认证，因为JSONP的请求没法发送HTTP Basic Auth凭证或者Bearer token。
在项目开发中，我们经常会使用REST风格进行API的定义，这篇文章为大家提供10条在使用REST API时的最佳实践。希望能够为你带来灵感和帮助。...这一条最佳实践非常明确，也就是说我们在使用REST API时，代表资源分类的部分，比如上图中的“users”和“customers”，使用users更泛化，不够具体，可能是To C的用户，也可能是To...为了保持版本的兼容性，依旧流量和功能的控制等，通常需要对API进行版本控制，这个是仅限于REST API，而是比较通用的一条最佳实践，特别是真的终端是APP的情况。...5、选择JSON字段命名约定 JSON标准没有强制规定字段命名约定，但最佳实践是选择一个并坚持使用。 选择适合团队和编程语言的JSON命名规则，具体采用哪种不重要，重要的是整个团队要确保统一。...你是否还有一些其他的最佳实践，也欢迎分享。
1 RPC 的工作机制 客户端调用一个远程的过程，将参数和附加信息序列化为消息，然后将消息发送到服务端。服务端在接受到消息后，将信息的内容反序列化，执行所请求的操作，然后将结果发送回客户端。...客户端和服务端各自负责参数的序列化和反序列化。 （远程过程调用的机制，图源：Guru99） 2 RPC 的优势 简单直接的交互。RPC 使用 GET 来获取信息，使用 POST 来处理其他所有操作。...3 REST 的不足 没有标准的 REST 结构：在构建 REST API 方面，没有具体的正确方法。如何对资源进行建模以及哪些资源需要建模取决于不同的情况。...API 向服务端发送一个庞大的查询，该 API 返回一个仅包含我们所需数据的 JSON 响应。...没有版本控制：版本控制的最佳实践是不要对 API 进行版本控制。
客户端通过请求资源来发出请求，然后请求出去寻找将满足请求的服务器。服务器找到所需的资源，然后将响应发送回客户端。 为什么API测试很重要？...标头的不同类型是： 常规 -可选的标头，其中包含诸如当前时间之类的信息 请求 -向服务器提供有关客户端的更多信息 实体 -包含有关发送文档的特定信息，例如长度和编码方案。...当围绕REST标准设计服务时，可以说使该服务“ RESTful”。 REST API由大量资源组成。这称为资源模型，它利用统一资源标识（URI）。...URI语法允许您指定一个查询，该查询从REST API返回所需的信息。REST系统的主要元素是： 资源是客户端请求从主机获取的信息，例如网页或数据库记录。 资源标识符是用于命名资源的URI。...表示形式是服务器发送带有完成格式的资源的响应时。
按需编码REST API 是使用 HTTP 协议的 Web API，其中客户端向 API 服务器发送 HTTP 数据请求，然后服务端将带有编码数据的 HTTP 响应回客户端。...在发送请求时，你会向资源传递一个与 CRUD（创建、读取、更新和删除）操作相对应的方法。将方法视为对资源采取的 “操作”，例如创建、更新或删除资源。...* **请求体：** 包含一个 JSON 对象，其中包含新资源的属性。在本例中，请求体包含新宠物的详细信息。请求体与参数类似，只是它们是包含多个属性的对象，而不是一个。...下面是向 Swagger Petstore API 发出的 REST API cURL 请求，该请求根据 petId 检索宠物。 `petId 1` 是一个路径参数，放在请求的资源 URL 末尾。...请求会被发送到一个处理检索的过程（GetPet 函数）。* 参数： * REST - 宠物 ID 作为路径参数传递给端点 URL。
省略 可以看到， k8s api 中都有一个对应的 kind 描述资源类型， 这个正好符合 RESTful 中资源定位的需求。 大概就是这样。.../k8sailor/v0/deployments # 针对特定名称资源的 deployment 操作 GET /k8sailor/v0/deployments/my-nginx-01?...结构体 发送给客户端， 否则客户端在使用的时候还需要在判断应答的结构体属于哪种。...把应答消息封装成一个标准结构， 具体消息信息用某个字段占有。.../overview/resources-in-the-rest-api kalaserach resp api 最佳实践: https://kalasearch.cn/blog/rest-api-best-practices
RPC 的工作机制 客户端调用一个远程的过程，将参数和附加信息序列化为消息，然后将消息发送到服务端。服务端在接受到消息后，将信息的内容反序列化，执行所请求的操作，然后将结果发送回客户端。...客户端和服务端各自负责参数的序列化和反序列化。 ? 远程过程调用的机制，图源：Guru99 RPC 的优势 简单直接的交互。RPC 使用 GET 来获取信息，使用 POST 来处理其他所有操作。...REST 的不足 没有标准的 REST 结构：在构建 REST API 方面，没有具体的正确方法。如何对资源进行建模以及哪些资源需要建模取决于不同的情况。...API 向服务端发送一个庞大的查询，该 API 返回一个仅包含我们所需数据的 JSON 响应。 ?...没有版本控制：版本控制的最佳实践是不要对 API 进行版本控制。
这是一篇综合指南，旨在深入探讨API开发，使初学者和有经验的开发人员都能充分挖掘API在项目中的潜力。 本指南将详尽探讨API开发的基本要素，包括涉及的概念、类型和协议，以及可用的最佳实践和工具。...端点通常围绕资源（如用户或产品）进行组织。 HTTP方法：标准的HTTP动词，如GET、POST、PUT、PATCH和DELETE，用于通过API对资源执行CRUD（创建、读取、更新和删除）操作。...请求与响应：API通信的基本组件，客户端向API发送请求，API处理并返回响应，通常采用JSON或XML等格式。 REST（表征状态转移）：一种流行的设计网络应用程序的架构风格。...四、构建正确 API 的最佳实践 构建正确API的最佳实践，需要遵循有助于维护、可扩展性和易用性三大原则。在开发API之前，详细规划和设计至关重要。...遵循已建立的架构原则（如REST），采用一致且直观的设计，使用有意义的命名约定以及资源和端点之间合理层次关系。
API 设计最佳实践，我将从头开始说起。...RESTful 接口 HTTP 形式的 API 最广泛接受的标准是 REST(Representational State Transfer)。它基本上意味着每个 URL 代表一个对象。...GET请求可以包含查询参数，以过滤从API接收的结果。 POST 向 API 提交一条记录，该记录将在数据库中创建一个资源。 PUT 一般用于更新服务器上的现有资源。...但是 API 可能已经有一个或多个开发者在使用了，所以，重要的是，你所做的更改不会破坏你的合作伙伴开发者的应用。...这些就是设计 API 的最佳实践。它让你的 API 更健壮、简洁并易于与其他应用程序集成。 请记住。
这篇最佳实践文章面向对创建 RESTful Web 服务感兴趣的开发人员，这些服务提供跨多个服务套件的高可靠性和一致性；遵循这些准则；服务定位于内部和外部客户快速、广泛、公开采用。...这是一个完整的图表，可以轻松理解 REST API 的原理、方法和最佳实践。 现在，让我们从每个盒子的原理开始详细说明它。...REST 定义了四个接口约束：资源的识别、通过表示的资源操作、自描述消息和作为应用程序状态引擎的超媒体。 自描述消息：每条消息都包含足够的信息来描述如何处理消息。...超媒体作为应用程序状态引擎 (HATEOAS)：客户端通过正文内容、查询字符串参数、请求标头和请求的 URI（资源名称）传递状态。服务通过正文内容、响应代码和响应头向客户端提供状态。...最佳实践 现在，让我们换个角度来了解 REST 的基本最佳实践，这是每个工程师都应该知道的。 保持简单和细粒度：创建模拟系统底层应用程序域或系统数据库架构的 API。
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
