Restful API 接口规范
文章目录
- Restful API 接口规范
- 背景
- 什么是RESTful架构呢?
- RESTful API 设计
Restful API 接口规范
暑假期间接触到实际开发项目对开发过程中遇到的Restful
接口规范存在疑惑,由于当时主要目的是尽快本地运行项目,尝试开发,没有对这个接口规范深入了解。趁着最近时间比较轻松,逐步学习Restful规范
。
背景
越来越多的人开始意识到,网站即软件,而且是一种新型的软件。
这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点。
网站开发,完全可以采用软件开发的模式。但是传统上,软件和网络是两个不同的领域,很少有交集;软件开发主要针对单机环境,网络则主要研究系统之间的通信。互联网的兴起,使得这两个领域开始融合,现在我们必须考虑,如何开发在互联网环境中使用的软件。
RESTful架构,就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。
什么是RESTful架构呢?
REST(Representational State Transfer)
REST的名称"表现层状态转化"中,省略了主语。“表现层"其实指的是"资源”(Resources)的"表现层"。
资源(Resources)
所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。
所谓"上网",就是与互联网上一系列的"资源"互动,调用它的URI。
表现层(Representation)
"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。
比如,文本可以用txt格式
表现,也可以用HTML格式
、XML格式
、JSON格式
表现,甚至可以采用二进制格式;图片可以用JPG格式
表现,也可以用PNG格式
表现。
URL
只代表资源的实体,不代表它的形式。严格地说,有些网址最后的".html"
后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用Accept
和Content-Type
字段指定,这两个字段才是对"表现层"的描述。
状态转化(State Transfer)
访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。
互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。
客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET
、POST
、PUT
、DELETE
。四个表示操作方式对应对应四种基本操作
- GET 获取资源
- POST 新建资源
- PUT 更新资源
- DELETE 删除资源
综合上面,RESTful架构
的内容:
- 每一个URI代表一种资源;
- 客户端和服务器之间,传递这种资源的某种表现层;
- 客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。
RESTful API 设计
API与用户的通信协议
采用
HTTPs
协议域名
用
api
关键字标识接口url
示例:
# 应该尽量将API部署在专用域名之下。# 表示前后端数据交互https://api.example.com# 应该尽量将API部署在专用域名之下。https://example.org/api/
路径
路径又称"终点"(endpoint),表示API的具体网址。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
HTTP动词
对于资源的具体操作类型,由HTTP动词表示。
GET(SELECT):从服务器取出资源(一项或多项)。POST(CREATE):在服务器新建一个资源。PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。DELETE(DELETE):从服务器删除资源。
不常用
HEAD:获取资源的元数据。OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。
- 状态码
200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)204 NO CONTENT - [DELETE]:用户删除数据成功。301:永久重定向302:暂时重定向400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
错误处理
状态码是4xx时,应返回错误信息,error当做key。
{error: "Invalid API key"}
返回结果格式
尽量采用json格式避免XML格式
GET /collection:返回资源对象的列表(数组)GET /collection/resource:返回单个资源对象POST /collection:返回新生成的资源对象PUT /collection/resource:返回完整的资源对象PATCH /collection/resource:返回完整的资源对象DELETE /collection/resource:返回一个空文档
Restful API 接口规范相关推荐
- RESTful API接口规范
RESTful规范 Restful API是目前比较成熟的一套互联网应用程序的API设计理念,Rest是一组架构约束条件和原则,如何Rest约束条件和原则的架构,我们就称为Restful架构,Rest ...
- RESTful API接口规范及使用
RESTful API接口规范及使用 REST 指的是一组架构约束条件和原则.满足这些约束条件和原则的应用程序或设计就是 RESTful. 非Rest设计,以往我们都会这么写:以不同的URL进行不通的 ...
- restful api接口规范_如何理解RESTful API设计规范?
作者:涂根华 https://www.cnblogs.com/tugenhua0707/p/12153857.html RESTful是目前最流行的API设计规范,它是用于Web数据接口的设计.从字面 ...
- restful api接口规范_Restful API设计规范
RESTFUL是一种网络应用程序的设计风格和开发方式,基于HTTP,可以使用XML格式定义或JSON格式定义.RESTFUL适用于移动互联网厂商作为业务使能接口的场景,实现第三方OTT调用移动网络资源 ...
- Restful API思路
1.通过服务器重写规则,将所有请求走一个入口方法,例如index.php的run()方法. 2.通过$_SERVER,找到请求方法,请求路径,请求参数,进行初始化参数 3.根据请求路径,走不同mode ...
- Restful API 的接口规范
发展背景及简介 网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备-).因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致 ...
- put url带参数_避免自己写的 url 被diss!建议看看这篇RESTful API简明教程!
RESTful API 是每个程序员都应该了解并掌握的基本知识,我们在开发过程中设计 API 的时候也应该至少要满足 RESTful API 的最基本的要求(比如接口中尽量使用名词,使用 POST 请 ...
- php restful规范,RESTFul API规范 详细指南
RESTFul规范 RESTFul是一种HTTP API接口规范,只要满足的RESTFul规范,即可称为RESTFul API. 既然是接口,我们先来了解一下,他和传统的API接口有何不同吧. 本文以 ...
- 使用CodeIgniter框架搭建RESTful API服务
RESTful不仅仅是一套协议标准更是一种设计思路. 在2011年8月的时候,我写了一篇博客<使用CodeIgniter框架搭建RESTful API服务>,介绍了RESTful的设计概念 ...
- RESTful API接口设计规范
目录 一.RESTful的诞生背景 二.什么是RESTful? 三.Restful API接口设计规范 3.1.协议 3.2.路径规则|域名 3.3.版本控制 3.4.请求类型 3.5.传入参数 3. ...
最新文章
- HTML中的map标签的使用
- iOS架构-制作静态库.a和.framework 的相互依赖(10)
- 服务器换账号登陆不了怎么办,怎么切换账号 更换账号 注册新的账号小技巧分享给你...
- PHP操作Mongodb API 及使用类 封装好的MongoDB操作类
- 乔布斯不在了,世界一大步,苹果一小步。
- Angular4---环境配置安装
- 给定一列非负整数,求这些数连接起来能组成的最大的数。
- Python的静态类型之旅
- 《供应链管理》—计划的三道防线
- netty实战pdf下载,深度解密:Java与线程的关系
- 数独解法-变形数独(第三讲:数独进阶方法(摒除))
- php用户注册登录6,【php】ThinkPHP6通过Ucenter实现注册登录
- Red Hat Enterprise Linux9 + Zabbix 6.2.3 + Grafana 9.2.0
- 如何理解P和NP问题
- LeetCode的SQL题练手(MySQL实现)
- js引用本地json文件
- 21点扑克游戏的出牌策略的研究
- VBA Excel 直接增加任意名字sheet
- MSTAR数据库结合深度学习(SAR图像目标检测与识别)
- Nginx 日志和监控 - HTTP 健康监测
热门文章
- python模块化 面向对象,Python学习记录4-面向对象,,OOP思想以模块化思
- ES(四)ES使用(基本查询、聚合查询)
- 触摸开关模块,TTP223
- 用python写一个躲避球十分简单的小游戏
- Busiest Computing Nodes
- list数组遍历时能不能使用remove()方法,要注意什么
- 京东618自动浏览叠蛋糕app
- 百度地图LV1.5实践项目开发工具类bmap.util.jsV1.1
- 广义相对论-学习记录7-第三章-张量分析与黎曼几何4
- 微信企业号服务器搭建,微信企业号开发之如何建立连接