DRF(Django Restframework) 十条规范

本文详细介绍了在使用Django Restframework构建API时的十条规范,包括使用独立域名或URL路径处理跨域问题,确保使用HTTPS协议,版本管理,资源命名,操作方式通过请求方法区分,资源过滤依赖接口参数,清晰的错误信息提示,成功的操作结果反馈,以及子资源链接的提供,以提升API的易用性和健壮性。
摘要由CSDN通过智能技术生成
  1. 【域名】单独给一个域名或url路径(出现跨域怎么解决?)
  2. 通常使用https
  3. 【版本】不同版本需要标注
  4. 【资源】资源最好使用名词
  5. 【操作方式】不从请求链接体现操作方式,在请求方式上解决操作方式
-- get:https://example.com/api/v1/books 获取所有
-- post:https://example.com/api/v1/books 新增一本
-- put:https://example.com/api/v1/book/1 更新id=1的一本
-- patch:https://example.com/api/v1/book/1 更新id=1的一本
-- delete:https://example.com/api/v1/book/1 删除id=1的一本
  1. 【资源过滤】通过接口传参来过滤资源
-- https://example.com/api/v1/books?limit=10 限制10
  1. 【错误信息】请求失败时需标注错误信息
{"message": "请求参数不合法"}
  1. 【操作结果】请求成功是返回结果
  2. 【子资源返回资源接口】返回的资源如果有子资源,返回子资源的链接地址,如查找书,书的封面图片就可以url表示
  3. 【方法】
GET 从服务器获取资源
POST 在服务新建资源
PUT 更新资源(完整)
PATCH 更新局部资源
DELETE 删除资源
HEAD 返回请求首部
CONNECT HTTP/1.1协议中预留给能够将连接改为管道方式的代理服务器。
OPTIONS 允许客户端查看服务器的性能。
TRACE 回显服务器收到的请求,主要用于测试或诊断。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值