端到端的超媒体REST API设计

Jimmy Bogard在他的一系列博客帖子中表示：REST是一种定义良好的架构风格，它能够为我们带来许多益处，但也经常被误用于描述各种各样的Web API。他特别着重描述了实现一个从服务器到客户端的端到端超媒体解决方案所必需的步骤，包括如何选择一种富超媒体的媒体类型（media type）。

Bogard是一位微软的MVP，他强调说，REST以及超媒体这种REST的约束会大大提高客户端与服务端API设计的复杂性。他认为只有在某些场景中才值得这么做，尤其是在客户端与服务端分别独立进行设计的情况下。如果客户端与服务端代码共存于一个源代码控制库，并且还是同时进行部署的，那么超媒体在这种情况下为他提供不了多少价值。

至于如何选择一种媒体类型，Bogard认为有这么三种选择：

选择某个现有标准。 \\
对某个现有标准进行扩展。 \\
设计属于自己的媒体类型。 \

考虑到设计一种媒体类型所需的精力，这已远不是在一个项目中就能够完成的工作了，因此他倾向于尽可能选择一种标准的媒体类型。在对不同的媒体类型的能力进行比较时，他提到了Mike Amundsen所设计的H Factor，这项工具能够衡量某个媒体类型对于超媒体的支持等级，帮助他做出适合于当前场景的最佳选择。不过，他往往发现所选择的媒体类型无法满足他的所有需求，因此不得不对所缺失的部分进行扩展。

Bogard认为服务端的设计与实现是非常直观的，这与创建一个纯粹的JSON API差别不大，只是增加了一个更丰富的超媒体模型的复杂性。通常来说，包含所选择的媒体类型的API在实现之后还要接受调用者的检验，从客户端的角度对其进行验收。

至于客户端方面，Bogard在文中提到，他所见到的大多数REST示例虽然包含了服务端的API，但往往未能提供实际的实例，使客户端了解如何调用它们。在Bogard的示例中，他创建了一个web客户端，其中包含了一个基本的导航视图。视图中包括了一些信息表，用户可通过这些信息配合在服务端响应中所包含的关系与链接查看详细的内容。服务端返回的响应中包括了大量的元数据，为了保持REST风格所提供的松耦合能力，客户端必须由这些元数据所驱动。但Bogard依然认为，客户端应当为某个特定的目的而设计，要打造一个泛用目的的客户端是非常无趣的。除了使用jQuery设计客户端之外，他还描述了如何使用React设计并实现客户端，由于React带有面向组件的特性，因此在Bogard看来，它能够非常完美地配合超媒体的使用。

查看英文原文：Design of a Hypermedia REST API Server and Consuming Client

端到端的超媒体REST API设计相关推荐

服务端指南 | 良好的 API 设计指南
设计一套良好的 API 接口. 原文地址:服务端指南 | 良好的 API 设计指南博客地址:blog.720ui.com/ 版本号在 RESTful API 中,API 接口应该尽量兼容之前的版本 ...
API+DevOps：华为云API Arts一体化平台，端到端呵护您的API
API+|以API-First理论为基础,以API为核心构建数字化生态摘要:华为云API Arts是API全生命周期一体化协作平台,支持开发者一站式高效实现API设计.API开发.API测试.API ...
蚂蚁金服 mPaaS 服务端核心组件体系概述：移动 API 网关 MGS
根据<开篇 | mPaaS 服务端核心组件体系概述>,我们已经初步了解 mPaaS 平台后端各组件的核心架构体系. 而在 mPaaS 服务端众多组件中,移动 API 网关 MGS 是连接移 ...
OpenCV textDetectionModel和textRecognitionModel API的端到端的实例(附完整代码)
OpenCV textDetectionModel和textRecognitionModel API的端到端的实例 OpenCV textDetectionModel和textRecognitionM ...
谷歌发布端到端AI平台，还有用于视频和表格的AutoML、文档理解API等多款工具
谷歌又有了大动作.在大洋彼岸的谷歌Cloud Next conference大会上,谷歌一口气发布了多款AI新品和工具,主要包括: 端到端的AI平台用于处理视频和表格数据的AutoML Tables ...
如何使用Postman和Newman在CI环境中自动化REST API端到端测试
Postman is a great tool to explore REST APIs. You can build requests and try them out to get quick f ...
ICCV2021- 牛津大学新的预训练视频文本数据集WebVid-2M，设计用于端到端检索的联合视频和图像编码器！代码已开源！...
关注公众号,发现CV技术之美 ▊ 写在前面视频文本检索的挑战包括视觉网络结构的设计和训练数据的性质 ,因为可用的大规模视频文本训练数据集 (例如HowTo100M) 是noisy的,因此只能通过大 ...
移动端页面制作字号大小设定问题,设计稿文字字号规范,解决移动端大小屏适配问题
移动端页面制作字号大小设定问题,设计稿文字字号规范,解决移动端大小屏适配问题参考文章: (1)移动端页面制作字号大小设定问题,设计稿文字字号规范,解决移动端大小屏适配问题 (2)https://ww ...
心法利器[78] | 端到端任务的拆解设计
心法利器本栏目主要和大家一起讨论近期自己学习的心得和体会,与大家一起成长.具体介绍:仓颉专项:飞机大炮我都会,利器心法我还有. 2022年新一版的文章合集已经发布,累计已经60w字了,获取方式看这里 ...

端到端的超媒体REST API设计

端到端的超媒体REST API设计相关推荐

最新文章

热门文章