Django世界-迈出第14步-RestFramework

最新推荐文章于 2022-04-26 17:30:22 发布
最新推荐文章于 2022-04-26 17:30:22 发布
阅读量163 收藏
点赞数
分类专栏： Django 文章标签： python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_41515213/article/details/104015347
版权

Dajngo学习

RESTful

1. 定义

RestFramework是一个能快速为我们提供API接口，方便我们编程的框架。API是后端编程人员写的，为了让前端拿数据的一个接口，通常就是以url的形式存在。

每个项目总有第一个人做基础构架，这个时候就不是仅仅实现一个API就OK了，需要考虑更多的事情，包括

  • 统一的异常处理
  • API权限
  • 统一的参数校验
  • 缓存如何可以做的更简单统一
  • 认证
  • 统一的查询过滤
  • 代码分层

2. REST

  • REST是一种标准，restful是一种规范，根据产品需求需要定出一份方便前后端的规范，与协议（如HTTP协议）不同，不是所有的标准要求都需要遵循。
  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
  • 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资* 源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
    对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

3. API规范

首先我们要知道，API并不是必须的，如果整个项目只有你一个人或者很少的人完成，完全可以直接用Django的模板引擎渲染发送到前端后直接操作。API的使用主要是为了解决多人开发，特别是前后端分离的情况。因为前端人员在制作页面时必然会需要向后端要数据，但是假如前后端是分离的，就不能用Django的render了，大部分情况前端会用ajax发送请求，后端人员则发送JSON字符串给前端，前端再反序列化后进行使用。这个时候其实我们设计一套API出来，就能使我们的任务轻松很多。所以，RestFramework就应运而生了。
API与用户的通信协议，本质上是HTTPs协议。

使用RestFramework设计API有一套规范，即RESTful，为了不平添与你合作开发的人的烦恼，我们还是要遵循这些规范。那么到底有哪些规范呢？

1 域名

域名上要显示你使用了API，我们有两种方式

https://api.example.com 方式一：将API部署在专用域名上（是官网的推荐方式，但这么做会存在跨域问题）
https://example.org/api/ 方式二： 写在路径上，API很简单

2 版本

我们的项目在开发过程中会进行功能的添加及优化，这个时候我们通常会为每一个版本设定一个版本号，版本号的显示也有两种方式

https://api.example.com/v1/　　 方式一： 写在路径上，API很简单
https://v1.example.com 方式二：将版本号部署在专用域名上（同样会存在跨域问题， 跨域时会引发发送多次请求）

3 路径

视网络上任何东西都是资源，所以路径均使用名词表示（可复数）

https://api.example.com/v1/zoos
https://api.example.com/v1/animals

4 请求方式

方式说明
GET从服务器取出资源（一项或多项）
POST在服务器新建一个资源
PUT在服务器更新资源（客户端提供改变后的完整资源——全部修改）
PATCH在服务器更新资源（客户端提供改变的属性——部分修改）
DELETE从服务器删除资源

5 过滤

通过在URL上传参的方式，有GET请求获取相应的数据

https://api.example.com/v1/zoos?limit=10：指定返回数据的数量
https://api.example.com/v1/zoos?offset=10：指定返回数据的开始位置
https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页以及每页的数据数量
https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

6 状态码

我们可以通过状态码来判断请求的状态，以处理相应的请求。在状态码是4开头时，应该捕捉相应错误并返回错误信息

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

7 常用状态码

{error: "Invalid API key"}#错误信息因用error作为key

8 返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范。

字段说明
GET/collection返回资源对象的列表
GET/collection/resource返回单个资源对象
POST/collection返回新生成的资源对象
PUT/collection/resource返回完整的资源对象
PATCH/collection/resource返回完整的资源对象
DELETE/collection/resource返回一个空文档

9 Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

Django REST framework 简介

序列化和反序列化可以复用

  1. 增:效验请求数据>执行反序列化过程>保存数据库>将保存的对象序列化并返回
  2. 删:判断要删除的数据是否存在.>执行数据库删除
  3. 改:判断要修改的数据是否存在>效验请求的参数>执行反序列化过程>保存数据库>将保存的对象序列化并返回
  4. 查:查询数据库>将数据序列化并返回

特点:

  1. 提供了定义序列化器Serializer的方法,可以快速根据Django ORM 或者其他库自动序列化/反序列化
  2. 提供了丰富的类视图\MIXIN扩展类,简化视图的编写
  3. 丰富的定制层级:函数视图\类视图\试图结合到自动生成API,满足各种需要
  4. 多种身份认证和权限认证方式的支持
  5. 内置了限流系统
  6. 直观的API web界面
  7. 可扩展性 , 插件丰富

Django REST framework 的核心任务

使用Django Rest framework的话，和之前使用Django时没多大差别，当然，更复杂的差别我也不知道

  1. 多了个serializers.py文件

这个文件的作用是Serializers把querysets和model instances这些复杂的数据结构转化为native Python 以便于以json,xml或其它内容类型的形式render出去。

  1. 视图的核心功能变了
  1. 将数据库数据序列化为前端需要的格式，并返回
    2 将前端发送过来的数据反序列化为模型类对象，并保存到数据库中

文档

参考文档：
https://www.jianshu.com/p/4a2ef111e05a

_Gavin124_
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
python django restful_详解Django rest_framework实现RESTful API
weixin_39561577的博客
11-29 230
一、什么是REST面向资源是REST最明显的特征，资源是一种看待服务器的方式，将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念，所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西，可以将资源设计的要多抽象有多抽象，只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似，资源是以名词为核心来组织的，首先关注的是名词...
django---restful framework初探
全干工程师
04-08 1835
RESTful协议 RESTful规则 django下的RESTful基本实现 RESTful协议 Fielding将他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写。我对这个词组的翻译是”表现层状态转化”。 如果一个架构符合REST原则，就称它为RESTful架构。 要理解RESTful架构，最好...
使用Django rest framework 编写restful接口（根据之前电商项目为例）
z_ipython的博客
08-03 1633
使用 Django restframework框架 编写API接口 一、在搭建rest framework接口之前我们先了解一下什么是API接口： API是应用程序编程接口，他是软件系统不同组成部分衔接的约定。可以理解为预先定义的函数。设计目的在于可以提供应用程序得以访问某些特定软件或硬件的能力，而又无需获知这些软硬件源码，也无需理解他们的内部工作机制细节。 API通常是以http的形式提供，它隐...
使用Django REST framework开发RESTful API接口 1
TLuffy的博客
03-31 647
新建项目 修改settings.py文件，后面会贴出完整的文件。 根目录新建static文件夹。 生成数据表 python manage.py makemigrations python manage.py migrate 创建管理员账号 python manage.py createsuperuser 运行项目，输入http://127.0.0.1:8000/amdin，进入后台，使用账户登陆。 配置项目 安装需要的包 打开 rest framework官方网站，查看需要引入的包。 在项目根目录新
Django REST framework 使用简记
weixin_30786657的博客
04-28 129
　　最近在参与的项目中需要使用到dajngo REST framework工具包进行开发,之前参与的项目几乎都是清一色的使用原生的django(话说偶尔也会使用一下Flask,真心不怎么喜欢这个框架),之前也有听说过这个工具包是如何的强大,奈何由于太(lan)忙(duo)的原因,一直没有好好去认真学习下,这回也算是临时抱佛脚了. Django rest framework介绍(纯属从其...
django-rest-framework-role-filters：django-rest-framework的简单角色过滤
02-05
标题"django-rest-framework-role-filters：django-rest-framework的简单角色过滤"指出，这是一个专门针对Django REST Framework（DRF）的扩展，用于实现基于角色的过滤功能。这意味着它允许开发人员根据用户的角色...
django-rest-framework-gis：Django REST Framework的地理附加组件。 由OpenWISP项目维护
02-05
**django-rest-framework-gis** 是一个扩展 **Django REST Framework** 的强大库，专注于处理与地理信息系统（GIS）相关的数据。这个项目由 **OpenWISP** 维护，旨在为开发人员提供一套全面的工具，以便在RESTful ...
django-rest-captcha
05-27
Django Rest验证码django-simple-captcha轻量级版本，可与django-rest-framework 。特征速度：使用cache代替数据库安全性：用于生成密钥和图像的联合方法。 （一个键不能生成很多图像） 简单：只需一个rest api...
django-rest-framework-files:对Django REST框架的文件下载和上传支持
05-09
REST框架文件 对Django REST框架的文件下载和上传支持。概述REST框架文件允许您下载用于呈现响应的格式的文件，并且还可以通过上传包含模型字段的文件来创建模型实例。要求Python（2.7、3.5、3.6） Django REST框架...
django-rest-witchcraft:Django REST Framework与SQLAlchemy的集成
03-21
django-rest-witchcraft是Django REST Framework的扩展，增加了对SQLAlchemy的支持。它旨在提供与使用SQLAlchemy的Django REST Framework和Django ORM构建REST api相似的开发经验。 安装 pip install django-rest-...
一个小项目带你了解rest framework
Dimples_54的博客
09-20 4828
这边声明一下，以下是参考官方文档来的。 新建项目 新建名为dimples的django项目 在其中建立一个名为astart的APP： 新建目录 # 新建目录 mkdir dimples cd dimples 新建虚拟环境 virtualenv env env\Scripts\activate 在虚拟环境中安装依赖 pip inst
Django Rest Framework简介及初步使用
热门推荐
Gscsd的博客
08-27 3万+
                                                使用Django Rest Framework之前我们要先知道，它是什么，能干什么用？ Django Rest Framework 是一个强大且灵活的工具包，用以构建Web API 为什么要使用Rest Framework           Django REST Framework可以在Dja...
Django restframework入门示例
卧龙居
12-16 1万+
1.前提 官网地址为：http://www.django-rest-framework.org/ 官方推荐安装以下安装包： Markdown URL：https://pypi.python.org/pypi/Markdown/ django-filter URL：https://pypi.python.org/pypi/django-filter django-cri
restframework（一）
小白
05-22 6997
restframework restframework是django对restful架构扩展的第三方库 restful架构 主要原则 网络上的所有事物都被抽象成为资源 每个资源都有唯一的资源标识符 同一个资源具有多种表现形式（xml， json等） 对资源的各种操作不会修改资源标识符 所有操作均是无状态的 符合REST原则的架构 什么是restful 对应的中文是res...
django_restframework模块学习
菲宇运维
09-18 505
一、rest_framework模块 apps authentication认证 authtoken (package) checks compat decorators documentation exceptions异常 fields字段 filters过滤 generics通用视图 manage...
挑战全网最全之django REST framework（DRF）教程
Timmy的博客
04-26 3万+
一、认识DRF 1、restful简介 在前后端分离的应用模式中，我们通常将后端开发的每个视图都称为一个接口，或者API，前端通过访问接口来对数据进行增删改查。 restful是一种后端API接口规范 1.1 http动词 对于资源的具体操作类型，由HTTP动词表示。 常用的HTTP动词有下面四个（括号里是对应的SQL命令）： GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器新建一个资源。 PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
Django REST Framework教程(一分钟入门)
像蚂蚁一样工作，像蝴蝶一样生活
03-23 2万+
　　引言 　　使用Django Rest Framework之前我们要先知道，它是什么，能干什么用？ 　　引用官方一句话：Django REST框架是用于构建Web API的功能强大且灵活的工具包。 　　那为什么要使用Rest Framework？ 　　Django REST Framework可以在Django的基础上迅速实现API，并且自身还带有WEB的测试页面，可以方便的测试自己的...
Django 判断用户是否登录和未登录跳转
weixin_41515213的博客
03-12 2062
在Django的实际应用中，我们通常会限制某些页面在登录后方可访问（如个人中心页面），否则就跳转到登录页面先进行登录。 在网上搜索到的直接使用装饰器@login_required放在view上方的做法当前版本（1.9.*以上）并不可用，会报以下错误： AttributeError: ‘function’ object has no attribute ‘as_view’ 那么该如何实现呢？以in...
Django世界-迈出第六步-发送邮件
weixin_41515213的博客
01-11 408
Dajngo学习Django 发送邮件setting.pyviews.py Django 发送邮件 Python中内置了一个smtp邮件发送模块，Django在此基础上进行了简单地封装，让我们在Django环境中可以更方便更灵活的发送邮件。 所有的功能都在django.core.mail中，常用的免费服务器有：163、126、QQ等。 SSL和TLS SSL：（Secure Socket ...
django-rest-framework-cache
最新发布
07-27
Django REST Framework Cache是一个Django框架的扩展，用于缓存REST API的响应数据。它提供了一种简单的方式来缓存API视图的响应，以减少数据库查询和加快请求的响应速度。 使用Django REST Framework Cache，你可以通过在视图类或视图函数上添加装饰器来启用缓存。这个扩展支持多种缓存后端，包括内存缓存、数据库缓存和文件缓存等。你可以根据你的需求选择适合的缓存后端。 为了使用Django REST Framework Cache，你需要在你的Django项目中安装并配置它。你可以通过pip安装它： ``` pip install djangorestframework-cache ``` 安装完成后，在你的项目的settings.py文件中添加以下配置： ```python INSTALLED_APPS = [ ... 'rest_framework_cache', ] CACHES = { 'default': { 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache', 'LOCATION': '127.0.0.1:11211', } } REST_FRAMEWORK_CACHE = { 'DEFAULT_CACHE_BACKEND': 'default', } ``` 然后，在你的API视图类或函数上使用`@cache_response`装饰器来启用缓存： ```python from rest_framework.decorators import api_view from rest_framework_cache.decorators import cache_response @api_view(['GET']) @cache_response(timeout=60*60*24) # 缓存一天 def my_view(request): ... ``` 这样，当该API被访问时，响应数据将会被缓存，并在下次请求相同的API时直接返回缓存的响应数据，而不需要执行相同的查询操作。 通过使用Django REST Framework Cache，你可以有效地提高REST API的性能和响应速度，并减少对数据库的负载。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值