RestFramework是一个能快速为我们提供API接口,方便我们编程的框架。API是后端编程人员写的,为了让前端拿数据的一个接口,通常就是以url的形式存在。
每个项目总有第一个人做基础构架,这个时候就不是仅仅实现一个API就OK了,需要考虑更多的事情,包括
1.统一的异常处理
2.API权限
3.统一的参数校验
4.缓存如何可以做的更加简单统一
5.认证
6.统一的查询过滤
7.代码分层
所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
那么到底有哪些规范呢?
1.域名
:域名上要显示你使用了API,我们有两种方式
2.版本
我们的项目在开发过程中会进行功能的添加及优化,这个时候我们通常会为每一个版本设定一个版本号,版本号的显示也有两种方式
视网络上任何东西都是资源,所以路径均使用名词表示(可复数)
4.请求方式
通过在URL上传参的方式,有GET请求获取相应的数据
200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务) 204 NO CONTENT - [DELETE]:用户删除数据成功。 400 INVALID 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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。 更多看这里:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
{error: "Invalid API key"}#错误信息因用error作为key
7.返回结果
针对不同操作,服务器向用户返回的结果应该符合以下规范。
{"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }}
转自https://www.jianshu.com/p/714b20de337a
原文:https://www.cnblogs.com/SlookUp/p/14527970.html