首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

撰写合格的REST API

两周前因为公司一次裁人,好几个人的活都被按在了我头上,这其中的一大部分是一系列REST API,撰写者号称基本完成,我测试了一下,发现尽管从功能的角度来说,这些API实现了spec的显式要求,但是从实际使用的角度...Headers 很多REST API犯的比较大的一个问题是:不怎么理会request headers。...Authorization字段的内容由":"分隔成两部分,":"前是access-key,":"后是HTTP请求的HMAC值。...其他 做到了接口一致性(符合RFC)和安全性,REST API可以算得上是合格了。当然,一个实现良好的REST API还应该有如下功能: rate limiting:访问限制。...不过要注意的是,hooks/event propogation可能会破坏REST API的幂等性,需要小心使用。

1.6K50

REST API和GraphQL API的比较

REST API REST(表述性状态传输)API 是一种应用程序接口 (API) 的架构风格,它使用 HTTP 请求来访问和使用数据。...主体包含客户端想要传输到服务器的数据,例如请求的有效负载。 GraphQL API GraphQL 是一种用于 API 的查询语言,也是使用现有数据完成这些查询的运行时。...GraphQL 与 REST: GraphQL 和 REST API 之间的主要区别在于 GraphQL 是一种查询语言,而 REST 是一种基于网络的软件的架构概念。...同样,将数据提供给客户端的方式是 GraphQL 和 REST 分歧最大的地方。在 REST 设计中,客户端提交 HTTP 请求,数据作为 HTTP 响应返回。...与 REST API 相比,这是一个明显的区别,在 REST API 中,每个 状态代码都指向某种类型的响应。

56310
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    GraphQL-to-REST API Connectors是Apollo的“最伟大的成就”

    REST API 还具有 GraphQL 可能无法提供的功能。虽然两者都支持从后端系统获取数据,但它们解决的是不同的问题,并且从不同的角度处理数据。...以加密货币交易平台提供商 Coinbase 为例,Connectors 未来可能会被使用,但 Coinbase 的后端服务需要的是 gRPC 而不是 REST API Connectors。...“例如,如果我们模式的某个部分没有高吞吐量,只要缓存策略足够,直接进行 API 调用可能是有意义的,”Saunders 说。...“但以我们目前的吞吐量,它不一定会解决我们所有的问题——你总是需要一台服务器。” Apollo 之所以为 REST 设计 Connectors,是因为它仍然是最流行的 API 格式。...“我们的愿景是将每个 API 都引入图中,”DeBergalis 说。

    10110

    REST API和SOAP API之间的区别

    REST是一种世界观,将信息提升为我们构建的体系结构的第一流元素。 Roy Fielding博士的论文“架构风格和基于网络的软件架构设计”介绍并整理了用于描述“RESTful”系统的思想和术语。...“无状态”这个术语是一个至关重要的部分,因为它允许应用程序以不一样的方式进行通信。 一个RESTful API服务通过统一资源定位器(URL)公开。这个逻辑名称将资源的标识与所接受或返回的标识分开。...这是最常见的请求,每次在浏览器中键入URL并单击return、选择书签或单击锚点引用链接时执行。 对于与RESTful API的编程交互,可以使用十几种或更多的客户端API或工具。...这种以不同形式请求信息的能力是可能的,因为资源的名称与其形式分离。尽管REST中的“R”是“表示”,而不是“资源”,但在构建允许客户以他们想要的形式询问信息的系统时,应该记住这一点。...基于rest的请求的一个重要方面是,每个请求包含足够的状态来响应请求。这就允许服务器上的可见性和无状态性、扩展系统所需的属性以及识别正在发出的请求。这种状态还允许缓存特定的结果。

    2K10

    REST API和SOAP API之间的区别

    大家好,又见面了,我是你们的朋友全栈君。 The Representational State Transfer (REST)架构风格不是可以购买的技术,也不是可以添加到软件开发项目中的库。...REST是一种世界观,将信息提升为我们构建的体系结构的第一流元素。 Roy Fielding博士的论文“架构风格和基于网络的软件架构设计”介绍并整理了用于描述“RESTful”系统的思想和术语。...“无状态”这个术语是一个至关重要的部分,因为它允许应用程序以不一样的方式进行通信。 一个RESTful API服务通过统一资源定位器(URL)公开。这个逻辑名称将资源的标识与所接受或返回的标识分开。...这是最常见的请求,每次在浏览器中键入URL并单击return、选择书签或单击锚点引用链接时执行。 对于与RESTful API的编程交互,可以使用十几种或更多的客户端API或工具。...这种以不同形式请求信息的能力是可能的,因为资源的名称与其形式分离。尽管REST中的“R”是“表示”,而不是“资源”,但在构建允许客户以他们想要的形式询问信息的系统时,应该记住这一点。

    1.3K20

    Flink REST API 的设计指南

    Flink REST API 介绍Flink REST API 是 JobManager 提供的 HTTP 接口,用户可以通过 GET、POST 等 REST 定义的方法,请求获取作业、JobManager...非阻塞的 Flink REST API 设计要点关于拓展 Flink REST API 的方法,我们可以在 Flink 官网文档、各类技术社区文章中得到详细的指引,因而这里不再赘述基础的细节,而是更侧重于讲解遇到的一些常见的问题和解决方案...→ TaskManager → 用户定义的 Task请求体、返回体设计通常对于接受 GET 方法的 REST API 而言,可以直接使用 EmptyRequestBody 类作为请求体的结构,方便快捷...但对于 POST 方法的 API,我们通常需要实现 RequestBody 接口,来定义该 REST 接口的请求体。...REST Handler 设计handler 是一个 REST API 接口的执行者,我们可以通过实现 handleRequest 方法来定义请求的处理逻辑。

    1.7K20

    你确定你的 REST API 真的符合 REST 规范?

    RESTful API 的存在是 web 开发历史上的一个里程碑。在本文中,我将和你探讨几种节省 REST API 开发时间的方法,并给出相关的 Node.js 示例。...RESTful API 背后的思想是遵循REST 规范中描述的所有架构规则和限制的方式进行开发。然而,实际上,这在实践中基本上是不可能的。 一方面,REST 包含了太多模糊和模棱两可的定义。...REST API 规范能做什么? 尽管存在上面说到的缺点,但使用合理的方法,REST 仍然是创建真正优秀 api 的一个绝佳选择。...OpenAPI 规范 OpenAPI 是目前最广泛接受的 REST API 规范格式。...现在,我们可以开始探索如何充分利用它们进行 API 的编写。 1. 为 API 编写单元测试 行为驱动开发(BDD)是开发 REST api 的理想选择。

    29420

    RESTful架构REST名称REST的出处RESTful API各端的具体实现

    REST描述的是在网络中client和server的一种交互形式;REST本身不实用,实用的是如何设计 RESTful API(REST风格的网络接口); 2....Server提供的RESTful API中,URL中只使用名词来指定资源,原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。...Web端和Server只使用上述定义的API来传递数据和改变数据状态。格式一般是JSON。iOS和Android同理可得。...通过HTTP动词实现 REST的出处 Roy Fielding的毕业论文。参与设计HTTP协议,也是Apache Web Server项目(可惜现在已经是 nginx 的天下)的co-founder。...如果是平台的API,可以用成熟但是复杂的OAuth2,新浪微博这篇:授权机制说明 各端的具体实现 如上面的图所示,Server统一提供一套RESTful API,web+ios+android作为同等公民调用

    1.6K50

    REST API URI 设计的七准则

    在了解 REST API URI 设计的规则之前,让我们快速过一下我们将要讨论的一些术语。 URI REST API 使用统一资源标识符(URI)来寻址资源。...REST API 设计人员应该创建 URI,将 REST API 的资源模型传达给潜在的客户端开发人员。在这篇文章中,我将尝试为 REST API URsI 引入一套设计规则。...query] ["#" fragment] 规则#1:URI中不应包含尾随的斜杠(/) 这是作为 URI 路径中最后一个字符的最重要的规则之一,正斜杠(/)不会增加语义值,并可能导致混淆。...结论 当你设计 REST API 服务时,你必须注意资源,这些资源由 URI 定义。 你正在构建的服务中的每个资源,都将至少有一个 URI 来标识它。这个 URI 最好是有意义的,并能充分描述资源。...URI 应遵循可预测的层次结构,以增强可理解性,从而提高可用性:可预测的意义在于它们是一致的,层次结构建立在数据具有结构关系的意义上。 RESTful API 是为消费者编写的。

    1.4K40

    【API架构】REST API 设计的原则和最佳实践

    这是一个完整的图表,可以轻松理解 REST API 的原理、方法和最佳实践。 现在,让我们从每个盒子的原理开始详细说明它。...最佳实践 现在,让我们换个角度来了解 REST 的基本最佳实践,这是每个工程师都应该知道的。 保持简单和细粒度:创建模拟系统底层应用程序域或系统数据库架构的 API。...此外,我们可能希望指定要包含在响应中的资源的字段或属性,从而限制返回的数据量。我们最终想要查询特定值并对返回的数据进行排序。 版本控制:有很多方法可以破坏合同并对 API 开发中的客户产生负面影响。...资源命名:当资源命名正确时,API 是直观且易于使用的。做得不好,同样的 API 会让人感觉很笨拙,并且难以使用和理解。RESTful API 适用于消费者。...原因是“客户”是服务套件中的一个集合,而 ID(例如 33245)指的是集合中的这些客户之一。 监控:确保添加各种监控以提高 API 的质量或性能。

    1.4K10

    带有 Python REST Web 服务示例的 REST API 快速入门指南

    REST 背后的主要思想是资源。您想要在 Web 应用程序中访问的所有内容都是一种资源,无论是您想要下载、更新、删除的媒体还是文档。REST 定义了一种访问、传输和修改这些资源的方法。...3.缓存 缓存的出现是为了解决 REST 的无状态性问题。这个缓存是在客户端实现的,并且缓存了可缓存的响应。...它增加了系统的可扩展性。 RESTFul 实现的关键要素 1.资源 REST 背后的基本思想是资源,存储在 REST Web 服务数据存储中的所有内容都是资源。...创建 API 端点和 REST 方法 接下来,我们需要创建 api 端点和所需的 REST 方法,如下所示。 GET 方法将在文章列表中搜索请求的类别,如果找到则返回数据以及响应代码 200 OK。...def delete(self,category): 4.注册资源并分配URI 我们的最后一步是将我们的资源注册到 REST API 并为其分配一个 URI。

    2.2K00

    什么是RESTful,REST api设计时应该遵守什么样的规则?

    作为一名开发者,相信在看的各位都知道“REST”这个术语,但是 REST 是什么意思,什么是 RESTful 服务?今天笔者带大家好好了解一下 RESTful。什么是REST?...REST 是由计算机科学家 Roy Fielding 定义的,他在 2000 年的博士论文中介绍了 REST 原则。...符合 REST 的系统,通常称为 RESTful 系统,其特点是它们是无状态的,并且将客户端和服务器的关注点分开,即前后端分离。...这就是前后端分离的优势所在。如何使用REST API?HTTP 动词REST API 通过各种 HTTP 请求方法,使前端与服务器的通信过程更容易,最常用的方法是:GET : 用于读取服务器上的数据。...是一种软件架构风格,用于 Web 架构的设计,任何遵循 REST 设计原则的 API都被称为 RESTful,在开发初期,开发者需要花费大量的时间去设计接口,这些接口一般都是遵循RESTful风格,力争接口简单

    1.2K30

    正确甄别API、REST API、RESTful API和Web Service之间的异同

    REST API是一组关于如何构建Web应用程序API的架构规则、标准或指导,或者说REST API是遵循API原则的一种架构风格。...如果按照数学上集合的概念来解释API与REST API之间的联系与区别,API是REST API的超集,REST API 是API的子集;所有的REST API都是API,但不是所有的API都是REST...2、REST API 与RESTful API 在第一小节中,了解了什么是REST API,接下来聊聊REST API与RESTful API之间的异同。...总结 如上所述,我们了解了什么是API,什么是REST API,什么是RESTful API以及Web Service的相关概念。...REST API是API的一个子集,所有的REST API都是API;RESTful API是对REST API架构风格的一种非正式实现方式。

    26.4K1313
    领券