Django RESTful API设计指南
RESTful API设计指南
#1 环境
Python3.7.3
djangorestframework==3.8.2#2 动词
methods | url | 说明 |
|---|---|---|
GET | /zoos | 列出所有动物园(列表) |
GET | /zoos/id/ | 获取某个指定动物园的信息(详细信息) |
POST | /zoos | 新建一个动物园 |
PUT | /zoos/id/ | 更新某个指定动物园的信息 |
DELETE | /zoos/id/ | 删除某个指定动物园 |
#3 状态码（Status Code）
#3.1 HTTP 状态码主要有以下几类
- 1xx —— 元数据
- 2xx —— 正确的响应
- 3xx —— 重定向
- 4xx —— 客户端错误
- 5xx —— 服务端错误
#3.2 常见的 HTTP 状态码可见以下表格
代码 | msg | methods | 说明 |
|---|---|---|---|
100 | Continue | [*] | 客户端应当继续发送请求。 |
200 | Ok | [GET] | 请求已成功，请求所希望的响应头或数据体将随此响应返回。 |
201 | Created | [POST/PUT/PATCH] | 用户新建或修改数据成功。 |
202 | Accepted | [*] | 表示一个请求已经进入后台排队（异步任务 |
204 | No Content | [DELETE] | 用户删除数据成功。 |
400 | Bad Request | [POST/PUT/PATCH] | 服务器不理解请求的语法。 |
401 | Unauthorized | [*] | 表示用户没有权限(令牌、用户名、密码错误),未登录时,访问需要登录的页面。 |
403 | Forbidden | [*] | 服务器拒绝请求,表示用户得到授权（与401错误相对），但是访问是被禁止的。已经登录,但是禁止访问某些页面。 |
404 | NOT Found | [*] | 服务器找不到请求的网页,用户发出的请求针对的是不存在的记录，服务器没有进行操作。 |
406 | Not Acceptable | [GET] | 用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。 |
410 | Gone | [GET] | 用户请求的资源被永久删除，且不会再得到的。 |
422 | Unprocesable entity | [POST/PUT/PATCH] | 当创建一个对象时，发生一个验证错误。 |
500 | Internal Server Error | [*] | 服务器发生错误，用户将无法判断发出的请求是否成功 |
502 | Server Error | [*] | 后端服务挂掉或者服务器压力过大，nginx接到的请求无法及时传递给后端的服务处理，这个时候就会出现502错误。 |
#4 curl 命令参考
curl -i -H "Content-Type: application/json" -X DELETE http://localhost:5632/blog/api/articles/2选项 | 作用 |
|---|---|
-X | 指定 HTTP 请求方法，如 POST，GET, PUT |
-H | 指定请求头，例如 Content-type:application/json |
-d | 指定请求数据 |
—data-binary | 指定发送的文件 |
-i | 显示响应头部信息 |
-u | 指定认证用户名与密码 |
-v | 输出请求头部信息 |
腾讯云开发者
