没有合适的资源?快使用搜索试试~ 我知道了~
首页RESTful-API设计原则与规范
RESTful-API设计原则与规范
5星 · 超过95%的资源 需积分: 32 69 下载量 192 浏览量
更新于2023-03-16
评论
收藏 516KB DOCX 举报
一、背景与基础概念 二、RESTful API应遵循的原则 1、协议(Protocol) 2、域名(ROOT URL) 3、版本(Versioning) 4、路径(Endpoints) 5、HTTP动词(HTTP Verbs) 6、过滤信息(Filtering) 7、状态码(Status Codes) 8、错误处理(Error handling) 9、返回结果(Response) 10、使用HATEOAS的Hypermedia API 11、认证(Authentication) 三、Swagger API标准
资源详情
资源评论
资源推荐
RESTful API 设计原则与规范
一、背景与基础概念...........................................................................................................2
二、RESTful API 应遵循的原则..........................................................................................3
1、协议(Protocol)...............................................................................................................3
2、域名(ROOT URL)..........................................................................................................3
3、版本(Versioning)...........................................................................................................3
4、路径(Endpoints)............................................................................................................4
5、HTTP 动词(HTTP Verbs)..............................................................................................5
6、过滤信息(Filtering)...................................................................................................6
7、状态码(Status Codes)..............................................................................................6
8、错误处理(Error handling)..........................................................................................7
9、返回结果(Response)................................................................................................8
10、使用 HATEOAS 的 Hypermedia API...........................................................................8
11、认证(Authentication)...............................................................................................9
三、Swagger API 标准.......................................................................................................9
REST,即 Representational State Transfer 的缩写。RESTful 架
构,是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于
理解、扩展方便,基于这个风格设计的软件可以更简洁,更有层次,更易
于实现缓存等机制,所以正得到越来越多网站的采用。如果一个架构符合
REST 原则,就称它为 RESTful 架构。
本文即将描述的,即是创建 RESTful 架构的 API 所要遵循的原则与规
范。
一、背景与基础概念
Web 应用程序最重要的 REST 原则是,客户端和服务器之间的交互
在请求之间是无状态的。从客户端到服务器的每个请求都必须包含理解请
求所必需的信息。
• 资源(resource):网络上的一个实体或者说是一个具体信息,可
以是一段文本、一张图片、一首歌曲、一种服务。
• 统一资源定位符(URI,Universal Resource Identier):一个
资源的识别符或者说是一个地址,通过 URI 你可以定位到特定的资源。
要获取这个资源,需要访问它的 URI,因此,URI 就成了每一个资源的
地址或独一无二的识别符。
• 状态转换(State Transfer): 所有资源都共享统一的接口,以便在
客户端和服务器之间传输状态。客户端与服务器互动的过程,通常涉及
到服务器端数据和状态的变化过程,比如文件被修改,访问数量增加等。
使用的是标准的 HTTP 方法,Http 标准中定义的最主要四个动词:
GET、POST、PUT、DELETE。它们分别对应四种基本操作:
- GET: 用来获取资源
- POST: 用来新建资源
- PUT: 用来更新资源
- DELETE: 用来删除资源
• Hypermedia 是应用程序状态的引擎,资源表示通过超链接互联。
二、RESTful API 应遵循的原则
模式
http(s)://server.com/app-name/{version}/{domain}/{rest-convention}
1、协议(Protocol)
API 与用户的通信协议,尽量使用 HTTPs 协议。HTTPs 协议的所有信
息都是加密传播,第三方无法窃听,具有校验机制,一旦被篡改,通信双
方会立刻发现,配备身份证书,防止身份被冒充。
2、域名(ROOT URL)
应该尽量将 API 部署在专用域名之下。
https://api.example.com
如果确定 API 很简单,不会有进一步扩展,可以考虑放在主域名下。
https://example.org/api/
3、版本(Versioning)
应该将 API 的版本号放入 URL。
https://api.example.com/v1/
另一种做法是,将版本号放在 HTTP 头信息中,但不如放入 URL 方便
和直观。Github 采用这种做法。
剩余14页未读,继续阅读
一棵树~
- 粉丝: 221
- 资源: 8
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- 数据结构1800题含完整答案详解.doc
- 医疗企业薪酬系统设计与管理方案.pptx
- 界面与表面技术界面理论与表面技术要点PPT学习教案.pptx
- Java集合排序及java集合类详解(Collection、List、Map、Set)讲解.pdf
- 网页浏览器的开发 (2).pdf
- 路由器原理与设计讲稿6-交换网络.pptx
- 火电厂锅炉过热汽温控制系统设计.doc
- 企业识别CIS系统手册[收集].pdf
- 物业管理基础知识.pptx
- 第4章财务预测.pptx
- 《集成电路工艺设计及器件特性分析》——实验教学计算机仿真系.pptx
- 局域网内共享文件提示没有访问权限的问题借鉴.pdf
- 第5章网络营销策略.pptx
- 固井质量测井原理PPT教案.pptx
- 毕业实习总结6篇.doc
- UGNX建模基础篇草图模块PPT学习教案.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论2