Resultful API

协议

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

域名

• 尽量将API部署在专用域名下：https://example.org/api/
• 如果API很简单，可以放在主域名下：https://example.org/api/

版本

• 将API版本号放入URL：https://api.example.com/v1/
• 将版本号放在HTTP头信息中

路径（终点/API具体网址）

• 每个网址代表一种资源，网址中需要用于数据库表格名对应的复数名词
• 例如，每个学校，提供包括老师、学生的信息
  https://api.example.com/v1/schools
  https://api.example.com/v1/teachers
  https://api.example.com/v1/students

http请求方法

• GET ：查（一项或多项）
• HEAD：查元数据
• POST ：增
• PUT ：更新所有
• PATCH：更新部分属性
• DELETE：删除
• 例如
  GET / schools：查所有学校信息
  GET / schools / ID：根据ID获取指定学校信息
  POST / schools：增加一个学生
  PUT / schools / ID：根据ID更新指定学校所有信息（提供该学生的全部信息）
  PATCH / schools / ID：根据ID更新指定学校所有信息（提供该学生的部分信息）
  DELETE / schools / ID：根据ID删除指定学校
  GET / schools / ID / students：根据ID列出指定学校的所有学生信息
  DELETE / schools / ID /students / ID：根据ID删除指定学校的指定ID的学生

过滤信息

• 记录数量很多时，API提供参数，过滤返回结果
  ?limit=10：指定返回记录的数量
  ?offset=10：指定返回记录的开始位置。
  ?page=2&per_page=100：指定第几页，以及每页的记录数。
  ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
  ?animal_type_id=1：指定筛选条件