首页
学习
活动
专区
圈层
工具
发布

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

RESTful API 背后的思想是遵循REST 规范中描述的所有架构规则和限制的方式进行开发。然而,实际上,这在实践中基本上是不可能的。 一方面,REST 包含了太多模糊和模棱两可的定义。...REST API 规范能做什么? 尽管存在上面说到的缺点,但使用合理的方法,REST 仍然是创建真正优秀 api 的一个绝佳选择。...因为你通过高质量的 API 规范实现的 api 将会是一致的,具有清晰的结构、良好的文档和高的单元测试覆盖率。 通常,REST API规范与其文档相关联。...API 项目中使用,还可以在客户端应用程序项目中使用,以描述与 API 一起工作的函数中的类型。...这将使使用你的 API 的开发人员感到轻松,并且肯定比手工填写 REST API 文档模板要好。

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

    撰写合格的REST API

    稍稍总结了些经验,在这篇文章里讲讲如何撰写「合格的」REST API。 RFC一致性 REST API一般用来将某种资源和允许的对资源的操作暴露给外界,使调用者能够以正确的方式操作资源。...一个合格的REST API需要根据Accept头来灵活返回合适的数据。...一般而言,如果对REST API的安全性要求比较高,那么,所有的API的所有操作均需得到授权。...其他 做到了接口一致性(符合RFC)和安全性,REST API可以算得上是合格了。当然,一个实现良好的REST API还应该有如下功能: rate limiting:访问限制。...metrics:服务器应该收集每个请求的访问时间,到达时间,处理时间,latency,便于了解API的性能和客户端的访问分布,以便更好地优化性能和应对突发请求。

    2K50

    REST API和GraphQL API的比较

    REST API REST(表述性状态传输)API 是一种应用程序接口 (API) 的架构风格,它使用 HTTP 请求来访问和使用数据。...主体包含客户端想要传输到服务器的数据,例如请求的有效负载。 GraphQL API GraphQL 是一种用于 API 的查询语言,也是使用现有数据完成这些查询的运行时。...同样,将数据提供给客户端的方式是 GraphQL 和 REST 分歧最大的地方。在 REST 设计中,客户端提交 HTTP 请求,数据作为 HTTP 响应返回。...在 GraphQL 架构中,客户端提交查询以获取数据。 典型场景 REST API 假设您有一个 API 来获取学生数据。...但是,由于可用的工具,客户端缓存优于 REST。一些使用缓存层的客户端(Apollo Client,URQL)使用 GraphQL 的模式和类型系统,允许它们在客户端保留缓存。

    1.7K10

    优雅调试 REST API 的工具

    找到一个超级漂亮同时功能超级强,还是一个 UWP 应用的调试 REST API 工具 点击此地址 下载安装 界面截图 ?...支持对请求设置标题,同时支持分组和工作空间 如我可以对访问逗比服务器添加多个不同的 API 请求 ?...我可以对一个项目的不同功能设置不同的分组,同时还可以切换工作空间 不过切换空间是需要升级为专业版的 当然清真的是这是一个 UWP 程序 我没有收他的红包,所以不好用请到官网喷 ---- 本文会经常更新...,请阅读原文: https://blog.lindexi.com/post/%E4%BC%98%E9%9B%85%E8%B0%83%E8%AF%95-REST-API-%E7%9A%84%E5%...B7%A5%E5%85%B7.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

    1.3K10

    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 方法来定义请求的处理逻辑。

    2.1K20

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

    客户端服务器 这个约束规定客户端和服务器的实现应该是独立的,两者都应该能够相互独立地扩展和发展。客户端应该只知道服务器上资源的 URI,别无其他。服务器应根据收到的客户端请求返回适当的响应。 2....3.缓存 缓存的出现是为了解决 REST 的无状态性问题。这个缓存是在客户端实现的,并且缓存了可缓存的响应。...创建 Python REST Web 服务 让我们使用 python 中的烧瓶创建一个简单的 REST Web 服务,我们可以使用 Postman 工具或 Curl 命令行实用程序来使用这个 Web 服务...创建 API 端点和 REST 方法 接下来,我们需要创建 api 端点和所需的 REST 方法,如下所示。 GET 方法将在文章列表中搜索请求的类别,如果找到则返回数据以及响应代码 200 OK。...def delete(self,category): 4.注册资源并分配URI 我们的最后一步是将我们的资源注册到 REST API 并为其分配一个 URI。

    3.1K00

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

    REST描述的是在网络中client和server的一种交互形式;REST本身不实用,实用的是如何设计 RESTful API(REST风格的网络接口); 2....Server提供的RESTful API中,URL中只使用名词来指定资源,原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。...比如: http://api.qc.com/v1/newsfeed: 获取某人的新鲜; http://api.qc.com/v1/friends: 获取某人的好友列表; http://api.qc.com...比如: DELETE http://api.qc.com/v1/friends: 删除某人的好友 (在http parameter指定好友id) POST http://api.qc.com/v1/...friends: 添加好友 UPDATE http://api.qc.com/v1/profile: 更新个人资料 禁止使用: GET http://api.qc.com/v1/deleteFriend

    1.9K50

    REST Client: 也许是比Postman更好的选择

    结尾的文件,填入你的HTTP请求,点击Send Request,或者右键选择Send Request,或者直接用快捷键 Ctrl+Alt+R ,你的REST API就执行了,然后API Response...HTTP语言 REST Client 添加了HTTP语言的定义,支持把以 .http 或者 .rest 结尾的文件当作HTTP语言,提供了语法高亮,代码自动补全,代码注释等功能。 ?...看到这里,你也许会问,我直接用Postman在GUI上填一填REST API的各个字段不就行了,干嘛还要写一个HTTP的文件。其实直接有一个HTTP文件的最大好处,就是方便分享。...也极大的方便管理你的所有REST API。 更方便的是,通过###分隔符,同一个HTTP文件里可以涵盖多个HTTP请求。不像Postman,不同的HTTP请求需要放在不同的tab里。 ?...高阶功能 其实REST Client还有很多的功能,有需求的童鞋可以慢慢挖掘,笔者列出了一些比较有用的高阶功能: Authentication:REST Client支持了Basic Auth,SSL

    2.4K10

    REST API和SOAP API之间的区别

    The Representational State Transfer (REST)架构风格不是可以购买的技术,也不是可以添加到软件开发项目中的库。...“无状态”这个术语是一个至关重要的部分,因为它允许应用程序以不一样的方式进行通信。 一个RESTful API服务通过统一资源定位器(URL)公开。这个逻辑名称将资源的标识与所接受或返回的标识分开。...对于与RESTful API的编程交互,可以使用十几种或更多的客户端API或工具。...如果没有对RESTful架构实现的更宏观的理解,很容易失去实践的意图。 REST最好用于管理系统,通过将产生和使用它的技术产生和使用的信息解耦。...OPTIONS OPTIONS还用于询问其他谓词是否适用于资源,从而询问服务器关于资源的情况。这使开发人员能够更好地理解如何针对资源进行交互和开发。

    2.7K10

    REST API和SOAP API之间的区别

    大家好,又见面了,我是你们的朋友全栈君。 The Representational State Transfer (REST)架构风格不是可以购买的技术,也不是可以添加到软件开发项目中的库。...“无状态”这个术语是一个至关重要的部分,因为它允许应用程序以不一样的方式进行通信。 一个RESTful API服务通过统一资源定位器(URL)公开。这个逻辑名称将资源的标识与所接受或返回的标识分开。...对于与RESTful API的编程交互,可以使用十几种或更多的客户端API或工具。...如果没有对RESTful架构实现的更宏观的理解,很容易失去实践的意图。 REST最好用于管理系统,通过将产生和使用它的技术产生和使用的信息解耦。...OPTIONS OPTIONS还用于询问其他谓词是否适用于资源,从而询问服务器关于资源的情况。这使开发人员能够更好地理解如何针对资源进行交互和开发。

    2K20

    分布式系统核心:REST风格的架构,REST成熟度模型及REST API管理

    ◆ 成熟度模型 正确、完整地使用REST是困难的,关键在于RoyFielding所定义的REST只是一种架构风格,它并不是规范,所以也就缺乏可以直接参考的依据。...对于不使用HATEOAS的REST服务,客户端和服务器的实现之间是紧密耦合的。客户端需要根据服务器提供的相关文档来了解所暴露的资源和对应的操作。...当服务器发生变化(如修改了资源的URI)时,客户端也需要进行相应的修改。而在使用HATEOAS的REST服务中,客户端可以通过服务器提供的资源的表达来智能地发现可以执行的操作。...◆ REST API管理 下面介绍几种简洁的REST API设计的最佳实践,可以作为真假REST的一个判别依据。 1.使用的是名词而不是动词 使用名词来定义接口。...它的重要性在于打破了客户端和服务器之间严格的合约,使得客户端可以更加智能和自适应,而REST服务本身的演化和更新也变得更加容易。 下面是一个HATEOAS的例子。

    1.2K20

    ReactiveCocoa实战: 模仿 花瓣,重写 LeanCloud Rest Api的iOS REST Client.

    这一次我们将要讨论的是移动开发中比较重要的一环--网络请求的封装.鉴于个人经验有限,本文将在一定程度上参考 基于AFNetworking2.0和ReactiveCocoa2.1的iOS REST Client...,来以LeanCloud的Rest Api来练手.前两节的示例,我们都是使用自定义的PHP接口来作为测试服务器,但是真实的服务器接口是涉及到许多细节的,比如一个基本的权限控制机制,用户登录登出等.为了能更真实快速的开始网络请求类的重构...模仿 "花瓣",重写 LeanCloud Rest Api的iOS REST Client....接下来的文字,思路上将在很大程度上参考 @limboy的文章,但是会相对更加完整.另外,其实 LeanCloud 其实是有自己的iOS API的,但是是一个抽象的封装,和实际应用中使用的网络请求API有很大不同...md5 加密 LeanClodu Rest API 需要在本地对masterKey在本地做一次md5加密,我封装了一个方法,可以直接用: /** * 将字符串md5加密,并返回加密后的结果

    1.3K90

    REST API URI 设计的七准则

    在了解 REST API URI 设计的规则之前,让我们快速过一下我们将要讨论的一些术语。 URI REST API 使用统一资源标识符(URI)来寻址资源。...REST API 设计人员应该创建 URI,将 REST API 的资源模型传达给潜在的客户端开发人员。在这篇文章中,我将尝试为 REST API URsI 引入一套设计规则。...REST API 不应该期望有一个尾部的斜杠,并且不应该将它们包含在它们提供给客户端的链接中。...两个不同的 URI 映射到两个不同的资源。如果 URI 不同,那么资源也会不同,反之亦然。因此,REST API 必须生成和传达清晰的 URI,并且不应容忍任何客户端尝试去对一个资源进行模糊的标识。...应鼓励 REST API 客户端使用 HTTP 提供的格式选择机制,即请求 header 中的 Accept 属性。

    1.8K40

    只需使用VS Code的REST客户端插件即可进行API调用

    而这些数据绝大部分都是由 REST API 端点提供的,通俗地说:我们想要的数据存在于其他服务或数据库中,我们的应用程序查询该服务来检索数据,并根据自己的需要使用数据。...在过去,为了在连接 UI 以接受数据之前测试 REST API,通常必须通过终端的命令行查询 API,或者使用像 Insomnia 或 Postman 这样的 GUI(我在之前的博客中对它们进行了比较)...所以当我决定每次需要测试一个新的 API 路由时,都要启动 Postman 或 Insomnia 是一件很痛苦的事情,我发现了 REST Client 这个插件,可以让这一切变得不必要。...测试一下:基本操作 这是很酷的部分:在我的经验中,这个小小的 REST Client 插件能够做的事情和 Postman 等更复杂的 API 客户端一样多。...我希望你能考虑用 REST Client 来处理你未来可能需要做的任何 API 查询,我想你会对它能提供的愉快体验感到惊喜,不需要任何 API GUI。

    9.7K20
    领券