RESTful API

Posted 可爱的红领巾

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了RESTful API相关的知识,希望对你有一定的参考价值。

什么是RESTful 

REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”或“表现层状态转化”。

 

其实也就是一种协议  因为早期公司内部流动性比较大,有很多人员的流动  最开始没有规范 造成了它的代码 接手的人读起来 很费劲,所以 慢慢的有了这个规范来让大家的代码尽量同意起来 便于观看  有很大可观性

 

RESTful API设计

API与用户的通信协议

 

下面是很普遍的规范:

 

域名 

https://api.example.com                         尽量将API部署在专用域名

https://example.org/api/                        API很简单

版本

1.  将版本信息放在URL中,如:https://api.example.com/v1/

2. 将版本信息放在请求头中。

路径

视网络上任何东西都是资源,均使用名词表示(可复数)

https://api.example.com/v1/zoos

https://api.example.com/v1/animals

https://api.example.com/v1/employees

method

GET      :从服务器取出资源(一项或多项)

POST    :在服务器新建一个资源

PUT      :在服务器更新资源(客户端提供改变后的完整资源)

PATCH  :在服务器更新资源(客户端提供改变的属性)

DELETE :从服务器删除资源

 

以上是关于RESTful API的主要内容,如果未能解决你的问题,请参考以下文章

一个基于Spring Boot的APIRESTful API项目骨架

一个基于Spring Boot的APIRESTful API项目种子(骨架)

从 Django 表单序列化

Koa.js 服务端请求性能优化

restful 接口 复杂对象入参

什么是REST以及 RESTful?