restful api接口规范是什么 (restful API)
本文目录导航:
restful api接口规范是什么?
REST(REpresentationStateTransfer)形容了一个架构样式的网络系统,比如web运行程序。
普通依赖于HTTP认证,HTTP认证有几种:basic,digest,token,这些都有规范的成功的开源包须要重要的是这个认证的帐号跟你业务的帐户实践是不一样的。
REST属于webService一种,安保是后盾服务的安保,因此不须要实践的业务帐号,理论是系统keyStore证书库里的账户。
RESTFUL特点包括:
1、每一个URI代表1种资源。
2、客户端经常使用GET、POST、PUT、DELETE4个示意操作方式的动词对服务端资源启动操作:GET用来失掉资源,POST用来新建资源(也可以用于降级资源),PUT用来降级资源,DELETE用来删除资源。
3、经过操作资源的体现方式来操作资源。
4、资源的体现方式是XML或许HTML。
5、客户端与服务端之间的交互在恳求之间是有形态的,从客户端到服务端的每个恳求都必定蕴含了解恳求所必需的消息。
restful api接口规范
restful api接口规范如下:
1、协定
API与用户的通讯协定,总是经常使用HTTPs协定。
2、域名
应该尽量将API部署在公用域名之下。
假设确定API很繁难,不会有进一步裁减,可以思考放在主域名下。
3、版本(Versioning)
应该将API的版本号放入URL。
另一种做法是,将版本号放在HTTP头消息中,但不如放入URL繁难和直观。
Github驳回这种做法。
4、门路(Endpoint)
门路又称终点(endpoint),示意API的详细网址。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
普通来说,数据库中的表都是同种记载的汇合(collection),所以API中的名词也应该经常使用双数。
举例来说,有一个API提供生物园(zoo)的消息,还包括各种生物和雇员的消息,则它的门路应该设计成上方这样。
Restful 格调API的接口设计规范
RESTful架构,其外围在于经过HTTP动词和URL来形容资源及其操作,成功了一种繁复高效的运行程序接口设计格调。
繁难了解,资源在URL中以名词方式展现,动词示意对资源的解决举措。
正确的设计遵照这一准则,而失误的设计则未能充沛口头此规范。
在RESTful格调中,资源被示意为URL地址中的名词,如用户、文章等,经过HTTP动词启动操作。
HTTP动词如GET用于读取资源,POST用于创立资源,PUT用于降级资源,DELETE用于删除资源。
这一设计使得接口的经常使用和了解愈加直观。
失误设计的例子理论会将操作与资源混杂,或许经常使用非规范或不明白的HTTP动词,造成接口难以了解和经常使用。
正确的设计则明晰地将动词与资源分别,经常使用规范HTTP动词启动操作,如GET恳求失掉资源,POST恳求创立资源等。
遵照RESTful规范的接口设计强调形态无反作用,即每次HTTP恳求都应该有明白的照应,并且形态应该是可预测的。
同时,设计应尽量防止经常使用全局形态,确保接口的可测试性和可保养性。
总结而言,RESTful架构经过繁复的URL和规范的HTTP动词成功了一种弱小的、可了解的接口设计格调。
遵照这一规范可以确保接口的高效、稳固和易于保养。