REST API URI 设计 7 准则,
分享于 点击 39057 次 点评:124
REST API URI 设计 7 准则,
在了解 REST API URI 设计的规则之前,让我们快速过一下我们将要讨论的一些术语。
URI
REST API 使用统一资源标识符(URI)来寻址资源。在今天的网站上,URI 设计范围从可以清楚地传达API的资源模型,如:
http://api.example.com/louvre/leonardo-da-vinci/mona-lisa
到那些难以让人理解的,比如:
http://api.example.com/68dd0-a9d3-11e0-9f1c-0800200c9a66
Tim Berners-Lee 在他的“Web架构公理”列表中列出了关于 URI 的不透明度的注释:
唯一可以使用标识符的是对对象的引用。当你没有取消引用时,你不应该查看 URI 字符串的内容以获取其他信息。- Tim Berners-Lee_
客户端必须遵循 Web 的链接范例,将 URI 视为不透明标识符。
REST API 设计人员应该创建 URI,将 REST API 的资源模型传达给潜在的客户端开发人员。在这篇文章中,我将尝试为 REST API URsI 引入一套设计规则。
在深入了解规则之前,先看一下在 RFC 3986 中定义的通用 URI 语法,如下所示:
URI = scheme "
相关文章
暂无相关文章
用户点评