构建 REST API 封面
Vapor 大型教程

构建 REST API

REST 把资源、URL 和 HTTP 方法组合起来,但规范不是把四个动词贴到路径上。这里用 Acronym 接口说明命名、状态码和返回结构。

什么是 REST

遵循 REST 风格的 API 可以和数据库的 CRUD(创建、查询、更新、删除)对应起来,用一种统一的模式操作资源,从而简化客户端的构建过程。

CRUD 与 HTTP 方法的映射

以“首字母缩写(acronym)”相关 API 为例,遵循 REST 风格可以这样定义:

创建(Create)

查询(Read)

更新(Update)

删除(Delete)

通过接口定义就能清楚知道它的功能,接口也比较规范和整洁,一般不需要注释就能理解。这里用一张表汇总:

操作HTTP 方法URL 示例含义
创建POST/api/acronyms新建一个首字母缩写
查询全部GET/api/acronyms/获取全部首字母缩写
查询单个GET/api/acronyms/1获取 ID 为 1 的缩写
更新PUT/api/acronyms/1更新 ID 为 1 的缩写
删除DELETE/api/acronyms/1删除 ID 为 1 的缩写

本系列其他文章