restful

Posted yangzhaon

tags:

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

  1. 什么是restful
  2. Restful api设计

什么是restful

1、Rest与技术无关,代表的是一种软件架构风格,中文成为"表征状态转移"

2、Rest从资源的角度审视整个网络,它将分布在网络中某个节点的资源通过url进行表示,客户端应用通过url来获取资源的表征,获得这些表征致使这些应用转变状态

3、所有的数据,不管是通过网络获取的还是(增删改查)的数据,都是资源、将一切数据视为资源是rest区别于其它架构风格的基本属性

4、对于rest这种面向资源的架构风格、有人提出一种权限的结构理念,即:面向资源架构

?

RESTful API设计

·API与用户的通信协议,总是使用https式协议(也有使用http的建议使用https安全)

?

·域名(表现形式)

????https://api.test.com????尽量将API部署在专用域名(会存在跨域问题)

????https://test.com/api????这种格式的很简单(大部分都使用这种方式)

?

·版本

????url,例如:https://api.test.com/v2

????请求头????跨域时,引发发送多次请求

?

·路径、视图网络上任何东西都是资源、均使用名词表示(可复用)

????https://api.test.com/v1/name

????https://api.test.com/v1/animals

????https://api.test.com/v1/zoos

?

·method(支持类型)

????GET????: 从服务器取出(查询)资源(单项或者所有)

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

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

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

????DELETE : 从服务器删除资源

?

·过滤,通过在url上 传参的形式传递搜索条件

????https://api.xxx.com/v1/zoos?limit=10 :????自定返回记录的数量

????https://api.xxx.com/v1/zoos?offset=10 : 指定返回记录的开始位置

????https://api.xxx.com/v1/zoos?page=2&per_page=100 : 指定第几页,以及每页的记录数

????https://api.xxx.com/v1/zoos?sortby=name&order=ase : 指定返回结果按照按个属性排序,以及排序顺序

????https://api.xxx.com/v1/zoos?animal_type_id=1 : 指定筛选条件

?

·状态码

技术图片

更多链接:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

?

·错误处理,应该要返回相应的错误信息,error当做key

????????Error:"invalid api key"


·返回结果,针对不同的操作,服务器向用户返回的结果应该符合下面规范。

#获取一个或所有资源

GET?/collection:返回资源对象的列表(数组)

GET?/collection/resource:返回单个资源对象

#新增资源

POST?/collection:返回新生成的资源对象

PUT?/collection/resource:返回完整的资源对象

# 更新资源

PATCH?/collection/resource:返回完整的资源对象

# 删除资源

DELETE?/collection/resource:返回一个空文档

?

?

·返回结果中提供链接:Hypermedia API,RESTful API最好做到Hypermedia,计时返回结果中提供链接,链向其他API方法,使得用户不查文档,也知道下一步应该做什么

"link":

??"rel":???"collection https://www.example.com/zoos",

??"href":??"https://api.example.com/zoos",

??"title":?"List of zoos",

??"type":??"application/vnd.yourformat+json"

?

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

RESTfulREST 与 RESTful 理解与实践

Restful API官方文档

RestFul接口设计

RESTful规范

RESTful规范

RESTful 规范