RestFul API中URI的设计原则和命名规范 restful api 设计指南,网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备...)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架
3) 资源标识应通过URI来定义,简单来说应该是只使用URI来完成服务器与客户端和资源之间的交互。这些URI可以看作一个RESTful服务提供的接口。 4) 支持JSON或XML等多种格式作为数据传输格式。 二、构建REST风格的API 1.API版本可以放在URL或者HTTP的Header里 http://example.com/api/v1/ http://api.example.com/...
RESTful API的设计原则 1. 资源表示 在RESTful API中,资源是核心概念。资源可以通过URL(Uniform Resource Locator)唯一标识。资源可以通过多种格式(如JSON、XML等)表示,并且可以根据客户端的需求返回不同的表示形式。2. HTTP动词与资源操作 • GET:用于获取资源的表示。• POST:用于创建新的资源。• PUT...
在设计RESTful API时,我们需要考虑以下几个方面:资源的命名:URI应该清晰、易懂,并且应该与业务逻辑相关。HTTP方法的使用:GET方法用于查询资源,POST方法用于创建资源,PUT方法用于更新资源,DELETE方法用于删除资源。URI参数的使用:URI参数应该用于对资源进行过滤、排序等操作。HTTP状态码的使用:HTTP状态码用于表示请求...
Route 定义混乱,完全违背 REST API URI 的一些设计原则。Action 命名不恰当。bool 返回值不合适。对于上面的三个问题,我们分别来探讨下。 1.URI 设计首先,我们知道在 REST API 中,URI 代表的是一种资源,它的设计要满足两个基本要求,第一名词而非动词,第二要能清晰表达出资源的含义, ...
DELETE:对应 DELETE 操作DELETE 请求用于从服务器删除资源,对应数据库中的 DELETE 操作。(逻辑删除依然是使用 put 或者 patch)。 3. RESTful 风格的基本原则 资源的唯一标识:每个资源都有一个唯一的URI。例如,/users/123 表示 ID 为 123 的用户。 无状态交互:每次客户端请求必须包含完成该请求所需的所有信息。服...
2.2 URI命名规范 https://{{host}}/api/{模块名}/{?菜单名}/{接口名}/:param *不能使用大写,用中横线 - 不用下划线 _ ; *使用名词表示资源集合,使用复数形式(为确保所有API URIs保持一致),不能使用动词; *每个资源都至少有一个标识它的URI,同时应该遵循一个可预测的层次结构来提高可理解性,从而提高可...
具体可以看:(https://blog.restcase.com/7-rules-for-rest-api-uri-design/) 在RESTful架构中,每个uri代表一种资源,因此uri设计中不能使用动词,只能使用名词,并且名词中也应该尽量使用复数形式。使用者应该使用相应的http动词 GET、POST、PUT、PATCH、DELETE等操作这些资源即可...
版本化API的通常方式有: 2.4.1 URI中设置版本 这种方式通常在URI中增加一段用于标识版本,例如/v1、/v2等。例如: curl https://example.com/api/v2/lists/3 这种方式的优势在于版本信息很容易明显的看出来,可以通过浏览器直接访问。 2.4.2 HTTP头中设置版本 ...
REST是设计风格而不是标准。REST通常基于HTTP、URI、XML以及HTML这些现有的广泛流行的协议和标准。