Skip to content

何为 API?

  • API(Application Programming Interface) 翻译过来是应用程序编程接口的意思。
  • RESTful API 经常也被叫做 REST API,它是基于 REST 构建的 API。
  • RESTful API 可以让你看到 URL+Http Method 就知道这个 URL 是干什么的,让你看到了 HTTP 状态码(status code)就知道请求结果如何。
    • 每一个 URI 代表一种资源,如果/book/1,表示 1 号书籍,
      • 只使用名词,不使用动词,动词由请求方式给定
      • 名词使用复数,因为通常对应数据库表,是集合。
      • 如果不涉及资源,可以使用动词。
      • 不用大写字母,用中杠 - 不用下杠 _
      • 用 v1 这种表示版本
      • 过滤信息用 url 参数拼在后面。
    • 客户端通过特定的 HTTP 动词,对服务器端资源进行操作,如DELETE 请求删除资源
  • 接口中尽量使用名词,使用 POST 请求创建资源,DELETE 请求删除资源等等
    • GET:请求从服务器获取特定资源。举个例子:GET /classes(获取所有班级)
    • POST:在服务器上创建一个新的资源。举个例子:POST /classes(创建班级)
    • PUT:更新服务器上的资源(客户端提供更新后的整个资源)。举个例子:PUT /classes/12(更新编号为 12 的班级)
    • DELETE:从服务器删除特定的资源。举个例子:DELETE /classes/12(删除编号为 12 的班级)
    • PATCH:更新服务器上的资源(客户端提供更改的属性,可以看做作是部分更新),使用的比较少,这里就不举例子了。

正在精进