# 一、RESTful API 简介

总结一下什么是RESTful架构

• 每一个URI代表一种资源
• 客户端和服务器之间，传递这种资源的某种表现层
• 客户端通过四个HTTP动词(GET、POST、PUT、DELETE)，对服务器端资源进行操作，实现"表现层状态转化"

# 二、RESTful API 设计

# 2.1、协议

• API与用户的通信协议，总是使用HTTPs协议

# 2.2、域名

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

https://api.example.com

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

https://example.org/api/

# 2.3、版本（Versioning）

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

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

# 2.4、路径（Endpoint）

• 表示API的具体网址

• 在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词

• 举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样

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

# 2.5、HTTP动词

• 对于资源的具体操作类型，由HTTP动词表示

• GET（SELECT）：从服务器取出资源（一项或多项）。

• POST（CREATE）：在服务器新建一个资源。

• PUT（UP