RESTfulAPI让请求语义化---kalrry

269 阅读2分钟

本文已参与「新人创作礼」活动,一起开启掘金创作之路。

前言

Win配置记录
Mac配置记录

GET与POST千古疑问-传送门

一、概念

RESTful (资源数据接口规范) 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。

前端设备层出不穷(手机、平板、桌面电脑、其他专用设备…)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行。RESTful API是目前比较成熟的API设计理论。要搞清楚restful规范,必须先了解REST。REST强调HTTP应当以资源为中心,并且规范了资源URI的风格;规范了HTTP请求动作(PUT,POST等)的使用,具有对应的语义。

即:不同的资源(信息)是不同的 uri

优点: 遵循REST规范的Web应用将会获得下面好处: URL具有很强可读性的, 具有自描述性; 资源描述与视图的松耦合 可提供OpenAPI, 便于第三方系统集成,提高互操作性; 如果提供无状态的服务接口,可提高应用的水平扩展性;

二、RESTfulAPI规范

  1. URI: URI(Uniform Resource Identifiers) 统一资源标示符,能够统一标识一个资源的符号都是URI
  2. URL: URL(Uniform Resource Locator) 统一资源定位符,是URI的一种体现形式

在restfulAPI的规范里,要让一个资源可以被识别,需要有个唯一标识,在Web中这个唯一标识就是 URI(Uniform Resource Identifier)

URI的格式定义如下

URI = scheme “😕/” 域名:端口号 “/” path [ “?” query ] [ “#” fragment ]

  1. 协议: API与用户的通信协议,总是使用HTTPs协议。
  2. 域名: 应该尽量将API部署在专用域名之下,如:api.example.com。(如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下,https://example.or…
  3. 例如版本号:api.kalrry.com/v1
  4. HTTP动词: GET(SELECT):从服务器取出资源(一项或多项)。 POST(CREATE):在服务器新建一个资源。 PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。 PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。 DELETE(DELETE):从服务器删除资源。 路径(Endpoint): 路径又称"终点"(endpoint),表示API的具体网址 如:api.kalrry.com/v1/GET/empl… 获取版本1里的所有employess的信息 如:api.kalrry.com/v1/GET/empl… 获取版本1里的id为01001的信息 如:api.kalrry.com/v1/GET/empl… 获取版本1里的编号为01001的信息 如:api.kalrry.com/v1/GET/empl…

总结: restful规范,最终核心规定的是由“动词”和“名词”构成的需求,这个需求就体现在URI上。 即:要求在URI上能够体现出需求

如: https://api.baidu.com/v1/GET/employees 表示 获取 员工信息
如: https://api.baidu.com/v1/POST/employees 表示 添加 员工信息

二、RESTful 架构详解

www.runoob.com/w3cnote/res…