HTTP 方法
资源操作必须尽可能使用正确的 HTTP 方法,并且必须遵守操作幂等性。HTTP 方法通常被称为 HTTP 动词。
下面是大禹安全 REST API 应该支持的方法列表。并非所有资源都支持所有方法,但使用以下方法的所有资源必须符合其用法。
| 方法 | 安全 | 幂等 |
|---|---|---|
| GET | 是 | 是 |
| POST | 否 | 否 |
| PUT | 否 | 是 |
| DELETE | 否 | 是 |
| PATCH | 否 | 否 |
| OPTIONS | 是 | 是 |
| HEAD | 是 | 是 |
关于以上方法的说明:
- GET 用于从服务器获取某个资源的信息
- 完成请求后返回状态码
200 OK - 完成请求后需要返回被请求的资源详细信息
- 完成请求后返回状态码
- POST 用于创建新资源
- 创建完成后返回状态码
201 Created - 完成请求后需要返回被创建的资源详细信息
- 创建完成后返回状态码
- PUT 用于完整的替换资源,比如修改 id 为 123 的某个资源
- 如果是替换了资源,则返回
200 OK - 完成请求后需要返回被修改的资源详细信息
- 如果是替换了资源,则返回
- PATCH 用于局部更新资源
- 完成请求后返回状态码
200 OK - 完成请求后需要返回被修改的资源详细信息
- 完成请求后返回状态码
- DELETE 用于删除某个资源
- 完成请求后返回状态码
204 No Content
- 完成请求后返回状态码
- OPTIONS 用于获取资源支持的所有 HTTP 方法
- HEAD 用于只获取请求某个资源返回的头信息