文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布

撰写合格的REST API

稍稍总结了些经验，在这篇文章里讲讲如何撰写「合格的」REST API。 RFC一致性 REST API一般用来将某种资源和允许的对资源的操作暴露给外界，使调用者能够以正确的方式操作资源。...一个合格的REST API需要根据Accept头来灵活返回合适的数据。...一般而言，如果对REST API的安全性要求比较高，那么，所有的API的所有操作均需得到授权。...HTTPS HMAC Auth尽管在保证请求的一致性上非常安全，可以用于鉴别请求是否由合法的请求者发起，但请求的数据和服务器返回的响应都是明文传输，对某些要求比较高的API来说，安全级别还不够。...其他 做到了接口一致性（符合RFC）和安全性，REST API可以算得上是合格了。当然，一个实现良好的REST API还应该有如下功能： rate limiting：访问限制。

2K50
    • 您找到你想要的搜索结果了吗？
    是的
    没有找到

    REST API和SOAP API之间的区别

    “无状态”这个术语是一个至关重要的部分，因为它允许应用程序以不一样的方式进行通信。 一个RESTful API服务通过统一资源定位器(URL)公开。这个逻辑名称将资源的标识与所接受或返回的标识分开。...这是最常见的请求，每次在浏览器中键入URL并单击return、选择书签或单击锚点引用链接时执行。 对于与RESTful API的编程交互，可以使用十几种或更多的客户端API或工具。...基于rest的请求的一个重要方面是，每个请求包含足够的状态来响应请求。这就允许服务器上的可见性和无状态性、扩展系统所需的属性以及识别正在发出的请求。这种状态还允许缓存特定的结果。...，但是对于您控制的信息空间，它是资源生命周期中有用的一部分。 删除请求是具有幂等性的。删除请求可能会被网络故障中断。无论第一个请求是否成功处理请求，资源都应该使用204(无内容)响应代码进行响应。...它可能需要一些额外的处理来跟踪以前删除的从未存在的资源和资源(应该返回404响应代码)。一些安全策略可能要求您返回一个404响应代码，以防止出现资源的泄漏信息。

    2.7K10

    REST API和SOAP API之间的区别

    “无状态”这个术语是一个至关重要的部分，因为它允许应用程序以不一样的方式进行通信。 一个RESTful API服务通过统一资源定位器(URL)公开。这个逻辑名称将资源的标识与所接受或返回的标识分开。...这是最常见的请求，每次在浏览器中键入URL并单击return、选择书签或单击锚点引用链接时执行。 对于与RESTful API的编程交互，可以使用十几种或更多的客户端API或工具。...基于rest的请求的一个重要方面是，每个请求包含足够的状态来响应请求。这就允许服务器上的可见性和无状态性、扩展系统所需的属性以及识别正在发出的请求。这种状态还允许缓存特定的结果。...，但是对于您控制的信息空间，它是资源生命周期中有用的一部分。 删除请求是具有幂等性的。删除请求可能会被网络故障中断。无论第一个请求是否成功处理请求，资源都应该使用204(无内容)响应代码进行响应。...它可能需要一些额外的处理来跟踪以前删除的从未存在的资源和资源(应该返回404响应代码)。一些安全策略可能要求您返回一个404响应代码，以防止出现资源的泄漏信息。

    2K20

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

    RESTful API 的存在是 web 开发历史上的一个里程碑。在本文中，我将和你探讨几种节省 REST API 开发时间的方法，并给出相关的 Node.js 示例。...RESTful API 背后的思想是遵循REST 规范中描述的所有架构规则和限制的方式进行开发。然而，实际上，这在实践中基本上是不可能的。 一方面，REST 包含了太多模糊和模棱两可的定义。...REST API 规范能做什么? 尽管存在上面说到的缺点，但使用合理的方法，REST 仍然是创建真正优秀 api 的一个绝佳选择。...因为你通过高质量的 API 规范实现的 api 将会是一致的，具有清晰的结构、良好的文档和高的单元测试覆盖率。 通常，REST API规范与其文档相关联。...这将使使用你的 API 的开发人员感到轻松，并且肯定比手工填写 REST API 文档模板要好。

    1.2K20

    优雅调试 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...但是，由于这套系统的调用是阻塞性的，如果某个 API 长期不响应，就会持续阻塞调用方，甚至会造成 JobManager 长期卡顿，严重影响其他接口的正常请求。...非阻塞的 Flink REST API 设计要点关于拓展 Flink REST API 的方法，我们可以在 Flink 官网文档、各类技术社区文章中得到详细的指引，因而这里不再赘述基础的细节，而是更侧重于讲解遇到的一些常见的问题和解决方案...REST Handler 设计handler 是一个 REST API 接口的执行者，我们可以通过实现 handleRequest 方法来定义请求的处理逻辑。...Server，造成 Flink UI 不响应的严重后果。

    2.1K20

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

    这是一个完整的图表，可以轻松理解 REST API 的原理、方法和最佳实践。 现在，让我们从每个盒子的原理开始详细说明它。...最佳实践 现在，让我们换个角度来了解 REST 的基本最佳实践，这是每个工程师都应该知道的。 保持简单和细粒度：创建模拟系统底层应用程序域或系统数据库架构的 API。...此外，我们可能希望指定要包含在响应中的资源的字段或属性，从而限制返回的数据量。我们最终想要查询特定值并对返回的数据进行排序。 版本控制：有很多方法可以破坏合同并对 API 开发中的客户产生负面影响。...服务通过在响应（如 Cache-Control、Expires、Pragma、Last-Modified 等）上设置标头来提高缓存能力 分页：REST 的原则之一是连通性——通过超媒体链接。...当链接在响应中返回时，API 变得更具自我描述性。对于支持分页的响应中返回的集合，“first”、“last”、“next”和“prev”链接至少是有益的。

    2K10

    REST API URI 设计的七准则

    在了解 REST API URI 设计的规则之前，让我们快速过一下我们将要讨论的一些术语。 URI REST API 使用统一资源标识符（URI）来寻址资源。...REST API 设计人员应该创建 URI，将 REST API 的资源模型传达给潜在的客户端开发人员。在这篇文章中，我将尝试为 REST API URsI 引入一套设计规则。...REST API 不应该期望有一个尾部的斜杠，并且不应该将它们包含在它们提供给客户端的链接中。...应鼓励 REST API 客户端使用 HTTP 提供的格式选择机制，即请求 header 中的 Accept 属性。...URI 的名称和结构应该向消费者传达意义。通过遵循上述规则，你将创建一个更加清晰的 REST API。这不是一个 REST 规则或约束，而是增强了 API。

    1.8K40

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

    3.缓存 缓存的出现是为了解决 REST 的无状态性问题。这个缓存是在客户端实现的，并且缓存了可缓存的响应。...假设客户端发送 GET 来查询 python 类别的数据，Web 服务器将在响应正文中返回数据。 6 响应代码 这些编码与响应一起返回，并表示发送到服务器的请求的状态。这些类似于 HTTP 响应代码。...创建 API 端点和 REST 方法 接下来，我们需要创建 api 端点和所需的 REST 方法，如下所示。 GET 方法将在文章列表中搜索请求的类别，如果找到则返回数据以及响应代码 200 OK。...def delete(self,category): 4.注册资源并分配URI 我们的最后一步是将我们的资源注册到 REST API 并为其分配一个 URI。...api.add_resource(Article, "/category/") TGS.run(debug=True,port=8080) 完整的 REST 示例程序

    3.1K00

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

    在Web应用程开发中，API是我们通过网络进行数据检索的一种主要方式，API文档将告知你检索数据的URL列表、查询参数、请求方式以及响应状态，其目的是降低Web应用程序开发难度，共享两个应用程序之间的数据...REST API是一组关于如何构建Web应用程序API的架构规则、标准或指导，或者说REST API是遵循API原则的一种架构风格。...如果按照数学上集合的概念来解释API与REST API之间的联系与区别，API是REST API的超集，REST API 是API的子集；所有的REST API都是API，但不是所有的API都是REST...也就是说，RESTful API是REST API的非正式实现方式，因为实现REST API的方式有很多，RESTful API只是其中一种，且没有完全满足REST API的所有设计原则，每个开发者在实现...REST API是API的一个子集，所有的REST API都是API；RESTful API是对REST API架构风格的一种非正式实现方式。

    28.8K1313

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

    ,来以LeanCloud的Rest Api来练手.前两节的示例,我们都是使用自定义的PHP接口来作为测试服务器,但是真实的服务器接口是涉及到许多细节的,比如一个基本的权限控制机制,用户登录登出等.为了能更真实快速的开始网络请求类的重构...xml格式,需要处理成 LeanCloud 需要的JSON格式才能导入,主站文章不多,几十篇,一个一个手动输,也是可以的.我将试着写一小段代码,来自动解析wp导出的文件,并根据需要生成对应的 JSON...模仿 "花瓣",重写 LeanCloud Rest Api的iOS REST Client....接下来的文字,思路上将在很大程度上参考 @limboy的文章,但是会相对更加完整.另外,其实 LeanCloud 其实是有自己的iOS API的,但是是一个抽象的封装,和实际应用中使用的网络请求API有很大不同...md5 加密 LeanClodu Rest API 需要在本地对masterKey在本地做一次md5加密,我封装了一个方法,可以直接用: /** * 将字符串md5加密,并返回加密后的结果

    1.3K90

    Elasticsearch——Rest API中的常用用法

    本篇翻译的是Elasticsearch官方文档中的一些技巧，是使用Elasticsearch必不可少的必备知识，并且适用于所有的Rest Api。 返回数据格式化 当在Rest请求后面添加?...pretty时，结果会以Json格式化的方式显示。另外，如果添加?format=yaml结果会以树的形式显示，默认都是Flase. 返回数据的易读性 结尾添加?...所有的API都接受一个参数——filter_path，这个参数支持逗号分隔，可以同时填写多个值。...Number 所有的API都支持以字符串的方式代表JSON中的数字类型。 Date 支持的类型上面都说过了... Geo Geo类型主要用于地图一类的数据，这里就先不介绍了。...返回结果——驼峰式 所有的API都接受一个case参数，如果设置为camelCase，那么所有的名称都会以驼峰式的形式返回。

    1.3K70
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

      Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

      深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 粤公网安备44030502008569号

      腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号

      领券