设计 URL

PPG007 ... 2021-12-27 Less than 1 minute

# 设计 URL

URL 应该由名词组成。

使用复数名词。

如果要表示单个资源,应该在复数名词后加唯一表示,例如:users/{id}

正确地使用 HTTP 方法和 URL 的组合:

URL POST GET PUT PATCH DELETE
/users 创建一个新用户 获取所有用户
/users/{id} 通过 id 获取用户 通过 id 更新全部字段或创建(如果不存在)用户 部分地更新用户 通过 id 删除用户

如果对于一些非常规的操作且没有合适的抽象资源描述,使用 POST + 动词结尾,例如 POST /bolg/translate

资源可以嵌套,也可以有子资源,PATCH 不能用于不可继续分割的属性。

可以将任意有意义的信息插入到资源路径中,表示对资源的描述。

Last update: December 27, 2021 03:30
Contributors: PPG007