目录

• RESTful API 介绍
  • RESTful介绍
  • RESTful API设计指南
    • API与用户的通信协议
    • 域名
    • 版本(Versioning)
    • 路径(Endpoint)
    • 浏览器请求方式(method)
    • 过滤信息(Filtering)
    • 状态码
    • 错误处理(Error handling)
    • 返回结果
    • Hypermedia API
    • 其他

RESTful API 介绍

RESTful介绍

REST是Representational StateTransfer的简称,中文翻译为"表征状态转移"或"表现层状态转化",本身与技术无关, 其代表的是一种软件架构风格,统一的架构开发风格,会减少开发者之间不少障碍.

RESTful API设计指南

API与用户的通信协议

[推荐阅读>>][2]
[2]: http://www.ruanyifeng.com/blog/2014/02/ssl_tls.html

域名

API部署在专用域名之下

https://api.example.com

API很简单不会有进一步扩展的时候可以放在主域名下

https://example.org/aip/

版本(Versioning)

1. API版本号放入到URl

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

2. API版本HTTP头信息中

路径(Endpoint)

1. 只能有名词
2. 与数据库的表格名对应
3. 名词使用负数

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

浏览器请求方式(method)

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

POST: 在浏览器新建一个资源

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

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

DELETE: 从服务器删除资源

过滤信息(Filtering)

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

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

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

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

https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序

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

状态码

1xx:表示信息类
2xx:成功类
3xx:重定向
4xx:客户端错误
5xx:内部服务器错误

[状态码大全>>][2]
[2]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

错误处理(Error handling)

状态码是4xx时,返回错误信息,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"
}}

其他

1. API的身份认证应该使用[OAuth 2.0框架>>][2]
   [2]: http://www.ruanyifeng.com/blog/2014/05/oauth_2_0.html
2. 服务器返回的数据格式, 应该尽量使用JSON, 避免使用XML.

原文地址：https://www.cnblogs.com/konghui/p/10351903.html