RESTful API

REST(Representational State Transfer)是一种Web服务设计风格,用于构建无状态、基于资源的API。RESTful API设计涉及使用HTTP动词(GET、POST、PUT、DELETE等)操作资源,遵循统一的接口原则。设计要点包括使用HTTPS协议、专用域名、URL版本控制、明确的路径、HTTP方法等。此外,错误处理、过滤信息、状态码和返回结果的规范化也是关键。遵循这些指南,可以创建高效、易于理解和使用的API。
摘要由CSDN通过智能技术生成

一、REST

    REST(Representational State Transfer,翻译为“表现层状态转化”)是所有Web应用开发都应该遵守的架构设计指导原则。

    面向资源是REST最明显的特征,对于同一个资源的一组不同操作。资源是服务器上一个可命名的抽象概念,资源是以名词为核心来组织的。

    REST要求,必须通过统一的接口来对资源执行各种操作,对于每个资源只能执行一组有限的操作,7个HTTP方法:GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS。

二、RESTful API 

    即符合REST设计标准的API。

    REST架构设计,遵循的各项标准和准则,就是HTTP协议的表现,换句话说,HTTP协议就是属于REST架构的设计模式,比如无状态,请求-响应。

三、RESTful API设计指南

1、协议

    API与用户的通信协议,总是使用HTTPs协议;

2、域名

     应该尽量将API部署在专用域名之下;

https://api.example.com

    如果API很简单,不会有进一步扩展,可以考虑放在主域名下;

https://example.org/api/

3、版本(Versioning)

    应该将API的版本号放入URL;

https://api.example.com/v1

   另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观;Github采用这种做法;

4、路径(Endpoint)

    路径又称终点,表示API的具体网址;

    在RESTful架构中,每个网址代表一种资源(resourse),所以网址中不能有动词,只能有名词,而且所有的名词往往与数据库的表格名对应;一般来说,数据库的表都是同种记录的"集合(collection)

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值