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

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

这是一个完整的图表，可以轻松理解 REST API 的原理、方法和最佳实践。 现在，让我们从每个盒子的原理开始详细说明它。...最佳实践 现在，让我们换个角度来了解 REST 的基本最佳实践，这是每个工程师都应该知道的。 保持简单和细粒度：创建模拟系统底层应用程序域或系统数据库架构的 API。...此外，我们可能希望指定要包含在响应中的资源的字段或属性，从而限制返回的数据量。我们最终想要查询特定值并对返回的数据进行排序。 版本控制：有很多方法可以破坏合同并对 API 开发中的客户产生负面影响。...为您的客户设计，而不是为您的数据设计。 - 复数：普遍接受的做法是始终在节点名称中使用复数形式，以保持您的 API URI 在所有 HTTP 方法中保持一致。...加QQ群，有珍贵的报告和干货资料分享。 视频号 【超级架构师】1分钟快速了解架构相关的基本概念，模型，方法，经验。每天1分钟，架构心中熟。

2K10

REST API 设计最佳实践：如何构建、设计和使用 API ？

但是，我主要接触的是REST，这是一种基于资源的API和Web服务开发架构风格。在我的职业生涯中有很大一部分时间都参与了构建、设计和使用API 的项目。...因此我决定写篇文章分享一下，在设计 REST API 时的最佳实践。以下是关于设计优秀REST API 的一些建议、提示和指导，帮助您让消费者（以及开发人员）满意。 1....学习 HTTP 基础知识 如果你想构建一个设计良好的REST API，那么你必须了解HTTP协议的基本知识。我坚信这将帮助你做出正确的设计选择。..., 4xx 表示客户端错误 和5xx 表示服务器错误 当然你还可以使用其他 HTTP 协议提供给 REST API 设计的功能 ，但这些都必须牢记在心里。...有一天，当我将REST API集成到我的一个项目中时，每次调用都收到HTTP 500内部错误。

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

    REST API和GraphQL API的比较

    REST API REST（表述性状态传输）API 是一种应用程序接口 (API) 的架构风格，它使用 HTTP 请求来访问和使用数据。...同样，将数据提供给客户端的方式是 GraphQL 和 REST 分歧最大的地方。在 REST 设计中，客户端提交 HTTP 请求，数据作为 HTTP 响应返回。...GraphQL 的安全控制不如 REST API 中的安全控制发达。为了利用 GraphQL 中的数据验证等当前功能，开发人员必须设计新的身份验证和授权技术。...可用性 REST API 使用 URI 和 HTTP 技术，这使得 API 很难预测在联系新端点时会发生什么。REST 中缺少指定的版本控制要求允许提供者采用他们自己的方法。...Status Code REST GraphQL 200 Ok Ok 400 Bad Request - 401 Unauthorized - REST API 的错误可以有 200 以外的任何代码，

    1.7K10

    API key 和 token 有什么区别？

    事实证明，很多人都无法告诉我 API key 和 token 之间的区别。因此文本我将向大家介绍它们之间的区别。 定义 我们可以通过以下定义来区分 API key 和 token。...API key — 通过代码调用 API 时提供的值，用于识别和授权调用者。它旨在以编程方式使用，通常是一长串字母和数字。 token — 代表用户会话或特定权限的一段数据。...如果 API key 或者 token 被恶意用户泄露或获取，潜在的损害有多严重？ API key — 由于这些密钥通常是长期存在的并且不限制对数据的访问，因此如果被泄露，可能会造成毁灭性的后果。...通常撤销 API key 是解决问题的唯一手段。应用程序通常需要具有良好的可观察性，以识别受损密钥并找到恶意用户。 token — 设计时考虑到了安全性。通常是短暂的并且很容易被撤销。...因此，我们根据用户的属性限制了功能和数据。 总结 API key 和 token 各有优缺点。一个并不比另一个更好。在决定要应用哪种身份验证机制时，请结合你的应用场景来进行选择。

    3.9K10

    REST API和SOAP API之间的区别

    REST是一种世界观，将信息提升为我们构建的体系结构的第一流元素。 Roy Fielding博士的论文“架构风格和基于网络的软件架构设计”介绍并整理了用于描述“RESTful”系统的思想和术语。...对于与RESTful API的编程交互，可以使用十几种或更多的客户端API或工具。...幸运的是，HTTP有一个内置的机制来过滤和返回不同格式的信息。如果服务器支持“接受”表示，则可以在标题和信息中指定此格式。这被称为内容协商，是HTTP中使用较少的一个方面。...如果没有对RESTful架构实现的更宏观的理解，很容易失去实践的意图。 REST最好用于管理系统，通过将产生和使用它的技术产生和使用的信息解耦。...通过明确和明确地定义这些动词的行为，客户可以在面对网络中断和失败时自主地做出决策。 有四个主要的HTTP动词是设计良好的RESTful系统使用的。 GET GET请求是Web上最常见的动词。

    2.7K10

    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 类作为请求体的结构，方便快捷...REST Handler 设计handler 是一个 REST API 接口的执行者，我们可以通过实现 handleRequest 方法来定义请求的处理逻辑。...在 REST Handler 的具体实现上，我们在 handleRequest 方法的传参里，可以看到有一个 ResourceManagerGateway 类型的 gateway 的参数，它就是 REST

    2.1K20

    REST API和SOAP API之间的区别

    REST是一种世界观，将信息提升为我们构建的体系结构的第一流元素。 Roy Fielding博士的论文“架构风格和基于网络的软件架构设计”介绍并整理了用于描述“RESTful”系统的思想和术语。...对于与RESTful API的编程交互，可以使用十几种或更多的客户端API或工具。...幸运的是，HTTP有一个内置的机制来过滤和返回不同格式的信息。如果服务器支持“接受”表示，则可以在标题和信息中指定此格式。这被称为内容协商，是HTTP中使用较少的一个方面。...如果没有对RESTful架构实现的更宏观的理解，很容易失去实践的意图。 REST最好用于管理系统，通过将产生和使用它的技术产生和使用的信息解耦。...通过明确和明确地定义这些动词的行为，客户可以在面对网络中断和失败时自主地做出决策。 有四个主要的HTTP动词是设计良好的RESTful系统使用的。 GET GET请求是Web上最常见的动词。

    2K20

    使用Spring Boot设计和实现REST API

    REST端点用于集成应用程序或服务器端向客户端提供服务。在本文中，将介绍基于CRUD的SpringBoot来设计和实现REST端点。...设计和实施端点 端点应简短易用。例如，为了通过Id获取客户，我们可以使用/ customers / {id}这样的端点。...所有这些方法都有助于设计简单的REST端点，因为这是标准的，所以每个人都可以理解它们。 GET GET方法用于访问资源。要根据ID获取客户记录，我们可以使用/ customers / {id}等端点。...当客户端请求无效或不存在的“id”时，我们可以使用标准HTTP响应代码，而不是使用自定义正文或错误消息进行响应。HTTP响应代码是REST中用于通知处理状态的标准方式。...有许多类别的代码可用，这里是关于这些代码的一些信息的链接。 404 - 未找到：如果数据存储中没有“id”，则使用此HTTP代码是合适的。

    2.5K30

    REST API URI 设计的七准则

    在了解 REST API URI 设计的规则之前，让我们快速过一下我们将要讨论的一些术语。 URI REST API 使用统一资源标识符（URI）来寻址资源。...在今天的网站上，URI 设计范围从可以清楚地传达API的资源模型，如： http://api.example.com/louvre/leonardo-da-vinci/mona-lisa 到那些难以让人理解的...REST API 设计人员应该创建 URI，将 REST API 的资源模型传达给潜在的客户端开发人员。在这篇文章中，我将尝试为 REST API URsI 引入一套设计规则。...REST API 不应该期望有一个尾部的斜杠，并且不应该将它们包含在它们提供给客户端的链接中。...URI 的名称和结构应该向消费者传达意义。通过遵循上述规则，你将创建一个更加清晰的 REST API。这不是一个 REST 规则或约束，而是增强了 API。

    1.8K40

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

    下面是设计REST风格的系统架构时需要满足或者遵循的一些基本条件和原则： 1、在REST架构中，Web中所有的事物（文本、音频、视频、图片、链接）都可以被统一的抽象为资源（resource） 2、在REST...4、可缓存（可选项），在REST架构中需要缓存来有效的处理大批量的请求 5、接口一致 现在，了解了API和REST API的基本概念，那这两者之间有什么异同？...REST API是Web API设计的一种规范或者指导原则，而RESTful API则是这中架构设计原则或者规范的一种具体实现方式。...也就是说，RESTful API是REST API的非正式实现方式，因为实现REST API的方式有很多，RESTful API只是其中一种，且没有完全满足REST API的所有设计原则，每个开发者在实现...接下来，通过一个简单的例子以加深对REST API和RESTful API的理解。下面将给出一个执行CURD操作的RESTful API设计案例： ?

    28.9K1313

    13 个设计 REST API 的最佳实践

    了解应用于 REST 之上的 HTTP 知识 如果你想要构建设计优良的 REST API，了解一些关于 HTTP 协议的基础知识是很有帮助的，毕竟磨刀不误砍材工。...但是，就 REST API 设计本身而言，所涉及到的 HTTP 知识要点大概包含以下几条： HTTP 中包含动词（或方法）： GET、POST、PUT、PATCH 还有 DELETE 是最常用的。...当然了，你可以将 HTTP 协议中所提供的任何东西应用于 REST API 的设计之中，但以上这些是比较基础的，因此时刻将它们记在脑海中是很有必要的。 2....但这样做的问题是，通常，web 框架并不是针对构建 REST API 服务而专门存在的，换言之，Flask 和 Express 是两个十分通用的框架，但它们并非特别适合用于构建 REST API 服务。...在 NodeJS 中，Restify 似乎也是一个不错的选择，尽管我还没有尝试过。我强烈建议你给这些框架一个机会！它们将帮助你构建规范，优雅且设计良好的 REST API 服务。

    4.2K20

    同步和异步编程执行API的方式有什么区别？

    同步API是指只有当前API执行完成后，才能继续执行下一个API。...步模式是指一个服务员某一时间段只能服务于一个客人的模式。 异步API是指当前API的执行不会阻塞后续代码的执行。...异步模式是指一个服务员同时可以服务多个客人的模式。 1.同步API的执行方式 同步API的执行方式是指代码从上到下一行一行执行，下一行的代码必须等待上一行代码执行完成后才能执行，示例代码如下。...2.异步API的执行方式 异步API的执行方式是指代码在执行过程中某行代码需要耗时，代码的执行不会等待耗时操作完成后再去执行下一行代码，而是不等待直接向后执行。...异步代码的执行结果需要通过回调函数的方式处理示例代码如下。

    20410

    REST API URI的七大设计原则

    在了解REST API URI设计的规则之前，让我们快速浏览一些我们将要讨论的术语。 URIs REST API使用统一资源标识符（URI）来寻址资源。...REST API设计人员应该在考虑将REST API资源模型传达给潜在的客户端开发者的前提下，创造URI。在这篇文章中，我将尝试为REST API URI 引入一套设计规则。...许多Web组件和框架将平等对待以下两个URI： http://api.canvas.com/shapes/ http://api.canvas.com/shapes 但是，实际上URI中的每个字符都会计入资源的唯一身份的识别中...应鼓励REST API客户端使用HTTP提供的格式选择机制Accept request header。 为了是链接和调试更简单，REST API应该支持通过查询参数来支持媒体类型的选择。...URI的名称和结构应该能够向使用者传达更清晰的含义。通过遵循上述规则，您将创建一个更清晰的的REST API与更友好的客户端。这些并不是REST的规则或约束，仅仅是API的增强和补充。

    2.2K60

    SpringBoot中REST API的错误异常处理设计

    RESTful API中的异常Exception处理有两个基本要求，需要明确业务意义的错误消息以及hhtp状态码。良好的错误消息能够让API客户端纠正问题。...Restful API错误/异常设计 在RESTful API中设计异常处理时，最好在响应中设置HTTP状态代码，这样可以表示客户端的请求为什么会失败的原因。...", "information_link": "/api/producer" } 在设计REST API的响应时，需要理解以下重点： 1. status表示HTTP状态代码。...我们可以将@ExceptionHandler加入基类控制器，来克服上面的不便和限制,但是有以下新问题： （1）基类控制器不适用于所有类型的控制器。我们还是需要复制代码。...在这篇文章中，我们介绍了实现Spring REST异常处理的不同选项。 为REST API构建一个良好的异常处理工作流是一个迭代和复杂的过程。

    8.3K31

    【面试题精讲】SPI 和 API 有什么区别？

    什么是 SPI 和 API？ SPI（Service Provider Interface） 是一种 Java 的扩展机制，用于实现模块化开发。...API 定义了如何使用某个软件库或框架提供的功能。 2. SPI 和 API 的区别是什么？...灵活性不同：API 的实现类必须在编译时就确定，无法动态替换；而 SPI 的实现类可以在运行时根据配置文件的内容进行动态加载和替换。...依赖关系不同：API 是被调用方依赖的，即应用程序需要引入 API 所在的库才能使用其功能；而 SPI 是调用方依赖的，即框架或库需要引入第三方实现类的库才能加载和调用。 3....总结 SPI 是一种 Java 的扩展机制，通过配置文件动态加载和调用第三方开发者实现的接口。与 API 相比，SPI 具有更高的灵活性和可扩展性，但也存在实现质量控制和配置复杂等缺点。

    2K20

    用ASP.NET Core 2.1 建立规范的 REST API -- 保护API和其它

    但是它主要用于包含页面的web应用, 例如MVC或Razor Page, 并不适用于REST/Web API, 所以不介绍它了....我一直在用Identity Server 4, 但是这里不会深入介绍, 这里主要介绍如何实现REST API, 如果有需要的话, 可以写一系列关于Identity Server 4的文章....请求token的地址是 /api/authentication, 请求token用的是Basic方案, Post方法里就是先解码, 验证用户名和密码, 成功后调用GenerateToken生成token...这样就可以保护API，避免一些非正常使用的场景，例如网络爬虫或请求太多而导致API的性能严重下降，Dos和DDos。...关于xUnit，我写过几篇文章，有兴趣可以参考下： http://www.cnblogs.com/cgzl/p/8283610.html http://www.cnblogs.com/cgzl/p/8287588

    1.6K20
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

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

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

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

      领券