网站ui设计给用户提交什么,中扶建设网站,河南中州路桥建设有限公司网站,经营之道的特点本文从分析现在流行的前后端分离Web应用模式说起#xff0c;然后介绍如何设计REST API#xff0c;通过使用Django来实现一个REST API为例#xff0c;明确后端开发REST API要做的最核心工作#xff0c;然后介绍Django REST framework能帮助我们简化开发REST API的工作。
Dj…
本文从分析现在流行的前后端分离Web应用模式说起然后介绍如何设计REST API通过使用Django来实现一个REST API为例明确后端开发REST API要做的最核心工作然后介绍Django REST framework能帮助我们简化开发REST API的工作。
Django-DRF全套笔记直接地址 请移步这里 共 5 章24 子模块 视图
Django REST framwork 提供的视图的主要作用
控制序列化器的执行检验、保存、转换数据控制数据库查询的执行
Request 与 Response
1. Request
REST framework 传入视图的request对象不再是Django默认的HttpRequest对象而是REST framework提供的扩展了HttpRequest类的Request类的对象。
REST framework 提供了Parser解析器在接收到请求后会自动根据Content-Type指明的请求数据类型如JSON、表单等将请求数据进行parse解析解析为类字典对象保存到Request对象中。
Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。
无论前端发送的哪种格式的数据我们都可以以统一的方式读取数据。
常用属性
1.data
request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性但提供如下特性
包含了解析之后的文件和非文件数据包含了对POST、PUT、PATCH请求方式解析后的数据利用了REST framework的parsers解析器不仅支持表单类型数据也支持JSON数据
2.query_params
request.query_params与Django标准的request.GET相同只是更换了更正确的名称而已。
2. Response
rest_framework.response.Response
REST framework提供了一个响应类Response使用该类构造响应对象时响应的具体数据内容会被转换render渲染成符合前端需求的类型。
REST framework提供了Renderer 渲染器用来根据请求头中的Accept接收数据类型声明来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明则会采用默认方式处理响应数据我们可以通过配置来修改默认响应格式。
REST_FRAMEWORK {DEFAULT_RENDERER_CLASSES: ( # 默认响应渲染类rest_framework.renderers.JSONRenderer, # json渲染器rest_framework.renderers.BrowsableAPIRenderer, # 浏览API渲染器)
}构造方式
Response(data, statusNone, template_nameNone, headersNone, content_typeNone)data数据不要是render处理之后的数据只需传递python的内建类型数据即可REST framework会使用renderer渲染器处理data。
data不能是复杂结构的数据如Django的模型类对象对于这样的数据我们可以使用Serializer序列化器序列化处理后转为了Python字典类型再传递给data参数。
参数说明
data: 为响应准备的序列化处理后的数据status: 状态码默认200template_name: 模板名称如果使用HTMLRenderer 时需指明headers: 用于存放响应头信息的字典content_type: 响应数据的Content-Type通常此参数无需传递REST framework会根据前端所需类型数据来设置该参数。
常用属性
1.data
传给response对象的序列化后但尚未render处理的数据
2.status_code
状态码的数字
3.content
经过render处理后的响应数据
3. 状态码
为了方便设置状态码REST framewrok在rest_framework.status模块中提供了常用状态码常量。
1信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS2成功 - 2xx
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS3重定向 - 3xx
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT4客户端错误 - 4xx
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS5服务器错误 - 5xx
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED视图概览
REST framework 提供了众多的通用视图基类与扩展类以简化视图的编写。
视图的继承关系 视图的方法与属性 视图说明
1. 两个基类
1APIView
rest_framework.views.APIView
APIView是REST framework提供的所有视图的基类继承自Django的View父类。
APIView与View的不同之处在于
传入到视图方法中的是REST framework的Request对象而不是Django的HttpRequeset对象视图方法可以返回REST framework的Response对象视图会为响应数据设置render符合前端要求的格式任何APIException异常都会被捕获到并且处理成合适的响应信息在进行dispatch()分发前会对请求进行身份认证、权限检查、流量控制。
支持定义的属性
authentication_classes 列表或元祖身份认证类permissoin_classes 列表或元祖权限检查类throttle_classes 列表或元祖流量控制类
在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。
举例
from rest_framework.views import APIView
from rest_framework.response import Response# url(r^books/$, views.BookListView.as_view()),class BookListView(APIView):def get(self, request):books BookInfo.objects.all()serializer BookInfoSerializer(books, manyTrue)return Response(serializer.data)2GenericAPIView
rest_framework.generics.GenericAPIView
继承自APIVIew主要增加了操作序列化器和数据库查询的方法作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时可搭配一个或多个Mixin扩展类。
提供的关于序列化器使用的属性与方法 属性 serializer_class 指明视图使用的序列化器 方法 get_serializer_class(self) 返回序列化器类默认返回serializer_class可以重写例如 def get_serializer_class(self):if self.request.user.is_staff:return FullAccountSerializerreturn BasicAccountSerializerget_serializer(self, *args, **kwargs) 返回序列化器对象主要用来提供给Mixin扩展类使用如果我们在视图中想要序列化器对象也可以直接调用此方法。 注意该方法在提供序列化器对象的时候会向序列化器对象的context属性补充三个数据request、format、view这三个数据对象可以在定义序列化器时使用。 * **request** 当前视图的请求对象* **view** 当前请求的类视图对象* format 当前请求期望返回的数据格式提供的关于数据库查询的属性与方法 属性 queryset 指明使用的数据查询集 方法 get_queryset(self) 返回视图使用的查询集主要用来提供给Mixin扩展类使用是列表视图与详情视图数据的基础默认返回queryset属性可以重写例如 def get_queryset(self):user self.request.userreturn user.accounts.all()get_object(self) 返回详情视图所需的模型类数据对象主要用来提供给Mixin扩展类使用。 在试图中可以调用该方法详情信息的模型类对象。 若详情访问的模型类对象不存在会返回404。 该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。 举例
url(r’^books/(?P\d)/$, views.BookDetailView.as_view()),
class BookDetailView(GenericAPIView): queryset BookInfo.objects.all() serializer_class BookInfoSerializer def get(self, request, pk):book self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象serializer self.get_serializer(book)return Response(serializer.data)#### 其他可以设置的属性* **pagination_class** 指明分页控制类
* **filter_backends** 指明过滤控制后端## 2. 五个扩展类#### 作用提供了几种后端视图对数据资源进行曾删改查处理流程的实现如果需要编写的视图属于这五种则视图可以通过继承相应的扩展类来复用代码减少自己编写的代码量。这五个扩展类需要搭配GenericAPIView父类因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法。### 1ListModelMixin列表视图扩展类提供list(request, *args, **kwargs)方法快速实现列表视图返回200状态码。该Mixin的list方法会对数据进行过滤和分页。源代码python
class ListModelMixin(object):List a queryset.def list(self, request, *args, **kwargs):# 过滤queryset self.filter_queryset(self.get_queryset())# 分页page self.paginate_queryset(queryset)if page is not None:serializer self.get_serializer(page, manyTrue)return self.get_paginated_response(serializer.data)# 序列化serializer self.get_serializer(queryset, manyTrue)return Response(serializer.data)举例
from rest_framework.mixins import ListModelMixinclass BookListView(ListModelMixin, GenericAPIView):queryset BookInfo.objects.all()serializer_class BookInfoSerializerdef get(self, request):return self.list(request)2CreateModelMixin
创建视图扩展类提供create(request, *args, **kwargs)方法快速实现创建资源的视图成功返回201状态码。
如果序列化器对前端发送的数据验证失败返回400错误。
源代码
class CreateModelMixin(object):Create a model instance.def create(self, request, *args, **kwargs):# 序列化器serializer self.get_serializer(datarequest.data)# 验证serializer.is_valid(raise_exceptionTrue)# 保存self.perform_create(serializer)headers self.get_success_headers(serializer.data)return Response(serializer.data, statusstatus.HTTP_201_CREATED, headersheaders)def perform_create(self, serializer):serializer.save()def get_success_headers(self, data):try:return {Location: str(data[api_settings.URL_FIELD_NAME])}except (TypeError, KeyError):return {}3 RetrieveModelMixin
详情视图扩展类提供retrieve(request, *args, **kwargs)方法可以快速实现返回一个存在的数据对象。
如果存在返回200 否则返回404。
源代码
class RetrieveModelMixin(object):Retrieve a model instance.def retrieve(self, request, *args, **kwargs):# 对象会检查对象的权限instance self.get_object()# 序列化serializer self.get_serializer(instance)return Response(serializer.data)举例
class BookDetailView(RetrieveModelMixin, GenericAPIView):queryset BookInfo.objects.all()serializer_class BookInfoSerializerdef get(self, request, pk):return self.retrieve(request)4UpdateModelMixin
更新视图扩展类提供update(request, *args, **kwargs)方法可以快速实现更新一个存在的数据对象。
同时也提供partial_update(request, *args, **kwargs)方法可以实现局部更新。
成功返回200序列化器校验数据失败时返回400错误。
源代码
class UpdateModelMixin(object):Update a model instance.def update(self, request, *args, **kwargs):partial kwargs.pop(partial, False)instance self.get_object()serializer self.get_serializer(instance, datarequest.data, partialpartial)serializer.is_valid(raise_exceptionTrue)self.perform_update(serializer)if getattr(instance, _prefetched_objects_cache, None):# If prefetch_related has been applied to a queryset, we need to# forcibly invalidate the prefetch cache on the instance.instance._prefetched_objects_cache {}return Response(serializer.data)def perform_update(self, serializer):serializer.save()def partial_update(self, request, *args, **kwargs):kwargs[partial] Truereturn self.update(request, *args, **kwargs)5DestroyModelMixin
删除视图扩展类提供destroy(request, *args, **kwargs)方法可以快速实现删除一个存在的数据对象。
成功返回204不存在返回404。
源代码
class DestroyModelMixin(object):Destroy a model instance.def destroy(self, request, *args, **kwargs):instance self.get_object()self.perform_destroy(instance)return Response(statusstatus.HTTP_204_NO_CONTENT)def perform_destroy(self, instance):instance.delete()3. 几个可用子类视图
1 CreateAPIView
提供 post 方法
继承自 GenericAPIView、CreateModelMixin
2ListAPIView
提供 get 方法
继承自GenericAPIView、ListModelMixin
3RetrieveAPIView
提供 get 方法
继承自: GenericAPIView、RetrieveModelMixin
4DestoryAPIView
提供 delete 方法
继承自GenericAPIView、DestoryModelMixin
5UpdateAPIView
提供 put 和 patch 方法
继承自GenericAPIView、UpdateModelMixin
6RetrieveUpdateAPIView
提供 get、put、patch方法
继承自 GenericAPIView、RetrieveModelMixin、UpdateModelMixin
7RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法
继承自GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin
未完待续 下一期下一章
Django-DRF全套笔记直接地址 请移步这里
