Representational State Transfer API 是一种用于设计 Web 服务的样式,因为它们越来越多地被广泛的客户使用。
要熟悉 Rest API,必须了解 HTTP API 的解构方式:
How the HTTP API’s request are deconstructed :
a.) 动词 -GET 请求资源
-POST 创建资源
-PUT 更新资源
-PATCH 更新资源部分资源
b.) 标头 - 内容类型 - 包含格式
- 内容长度 - 包含
内容的大小 - 授权 - 谁在进行调用
-接受- 什么类型可以接受
c.) 内容 - 有关请求的内容
d.) Cookies - 包含请求中的乘客数据
如何解构 HTTP API 的响应:
a.) 状态代码 - 操作状态代码。
b.) 标头 - 包含内容类型、内容长度、过期时间和 cookie。
c.) Content——关于响应的内容
设计 Rest API
在编写代码之前首先设计它,因为在发布它之后修复 API 并不推荐认为它是可能的。
设计一个 API 意味着设计它而不仅仅是 URI (统一资源标识符)
API 应该基于可以理解的简单 URI。
设计原则包括:
在端点路径中使用名词而不是动词
允许 API 过滤、排序和分页数据
对 REST API 进行版本控制。
接受并用 json 响应。
应该解决错误处理。
使用缓存也应该受到欢迎。
*设计结果 *
a.) 成员名称 - 不应暴露服务器详细信息,如 ruby 、
javascript 等
- 首选驼峰式
- 保持一致
b.) 超媒体 - 允许结果自我描述