drf框架

drf框架的全称:diango-rest framework,是一种后端框架。python

接口

  接口:链接两个物质的媒介,完成信息交互。而web程序中的接口:做为前台页面与后台数据库链接的媒介。 git

  web接口组成:web

    url:长得像放回数据的url连接。如api.baidu.map/search,一访问后台返回给你的是一大堆查询到的数据 结果 。做为接口最主要的部分。数据库

    请求参数:前台按照指定的key提供数据给后台django

    响应数据:后台与数据库交互后将数据反馈给前台json

  一个规定的请求参数的url访问后能返回对应的结果的url连接。后端

restful接口规范

  接口规范:就是为了采用不一样的后台语言,也能使用一样的接口获取到一样的数据。api

  如何写接口:接口规范是规范化书写接口的,写接口要写 url、响应数据。安全

    注意:若是将请求参数也归入考量范围,那就是在写 接口文档restful

url

  1)用api关键字来标识接口url。如:api.baidu.com | www.baidu.com/api

  2)考虑到接口数据安全性,优先选择https协议。

  3)若是一个接口中有多个不一样的版本,须要在url中标识体现出来。如:api.baidu.com/v1/... | api.baidu.com/v2/...

  4)接口操做的数据源称之为资源,在url中通常采用资源复数形式,一个接口能够归纳为对资源的多种操做方式。如:api.baidu.com/books | www.baidu.com/api/books(pk),操做单个资源的时候,须要用到主键pk。

  5)请求方式有多种,用一个url处理如何保证不混乱 ---> 经过请求方式标识操做资源的方式。

    /books      get       获取全部

    /books      post        增长一个(多个)

    /books/(pk)   delete      删除一个

    /books/(pk)   put        总体更新一个

    /books/(pk)   patch         局部更新一个

  6) 资源每每涉及数据的各类操做方式 ---> 筛选、排序、限制。如:api.baidu.com/books/?search=西&ordering=-price&limit=3

响应数据

  1) http请求的响应会有相对应的响应码,接口是用来返回操做的资源数据,能够拥有操做数据结果的状态码。status: 0(操做资源成功) ;1(操做资源失败); 2(操做资源成功,但没匹配结果)

注:资源状态码不像http状态码,通常都是后台与前台或是客户约定的

  2) 资源的状态码文字提示。如:status ok '帐号有误' '密码有误' '用户锁定'

  3) 资源自己。results。

    注意:删除资源成功不作任何数据返回(返回空字符串)

  4) 不能直接放回的资源(子资源、图片、视频等资源),返回该资源的url连接

基于restful规范的原生Django接口

主路由:url.py

1 from django.conf.urls import url, include
2 from django.contrib import admin
3 
4 
5 urlpatterns = [,
6     url(r'^admin/', admin.site.urls),        # 路由分发,分发给api中的路由
7     url(r'^api/', include('api.urls'))  
8 ]

api组件的子路由:api/url.py

1 from django.conf.urls import url
2 from . import views
3 
4 urlpatterns = [
5     url(r'^books/', views.Book.as_view()), # 执行as_view这个函数,再拿到执行结果
6     url(r'^books/(?P<pk>.*)/$', views.Book.as_view()),
7 ]

模型层:model.py

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5, decimal_places=2)

    class Meta:
        db_table = 'old_boy_book'
        verbose_name = '书籍'
        verbose_name_plural = verbose_name

    def __str__(self):
        return '《%s》' % self.title

后台层:admin.py

1 from django.contrib import admin
2 from . import models
3 
4 admin.site.register(models.Book)

数据库迁移

>: python manage.py makemigrations
>: python manage.py migrrate

>: python manage.py createsuperuser

视图层:views.py

from django.http import JsonResponse
from django.views import View
from . import models


# 六大基础接口:获取一个,获取全部,增长一个,删除一个,总体更新一个,局部更新一个
# 十大接口:群增,群删,总体改群改 局部改群改
class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')    # 有名分组
        if not pk:  # 若是有pk,查单个。若是没有pk,查全部
            # 操做数据库
            book_obj_list = models.Book.objects.all()  # 拿到全部的结果
            # 序列化过程
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            # 响应数据
            return JsonResponse({
                'status': 0,  # 资源的状态码
                'msg': 'ok',
                'results': book_list
            }, json_dumps_params={'ensure_ascii': False})
else: # 单查 book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first() if book_dic: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': book_dic }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 2, 'msg': '无结果', }, json_dumps_params={'ensure_ascii': False}) # postman能够完成不一样方式的请求:get | post | put ... # postman发送数据包有三种方式:form-data | urlencoding | json # 原生django对urlencoding方式数据兼容最好 def post(self, request, *args, **kwargs): # 前台经过urlencoding方式提交数据 try: book_obj = models.Book.objects.create(**request.POST.dict()) if book_obj: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': {'title': book_obj.title, 'price': book_obj.price} }, json_dumps_params={'ensure_ascii': False}) except: return JsonResponse({ 'status': 1, 'msg': '参数有误', }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 2, 'msg': '新增失败', }, json_dumps_params={'ensure_ascii': False})

Postman接口工具

  在官网下载安装https://www.getpostman.com/ ,详细安装步骤可见 http://www.onlinedown.net/soft/971602.htm 。

  get请求,携带参数采用Params。post等请求,不须要pk主键, 在Body中提交数据包能够采用三种方式:form-date、urlencoding、json。全部请求均可以携带请求头

 Drl安装和与封装风格

  安装所要输入的指令   >: pip3 install djangorestframework

drf框架规矩的封装风格

from rest_framework.views import APIView
from rest_framework.response import Response # 响应数据
from rest_framework.request import Request  # 请求数据
from rest_framework.serializers import Serializer # 序列化
from rest_framework.settings import APISettings # 
from rest_framework.filters import SearchFilter # 查询过滤器
from rest_framework.pagination import PageNumberPagination  # 分页
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated  # 是不是登陆用户
from rest_framework.throttling import SimpleRateThrottle  # 频率

class Test(APIView):
    def get(self, request, *args, **kwargs):
        return Response('drf get ok')

 drf请求生命周期

1) 请求走的是APIView的as_view函数

2) 在APIView的as_view调用父类(django原生)的as_view,还禁用了 csrf 认证

3) 在父类的as_view中dispatch方法请求走的又是APIView的dispatch

4) 完成任务方法交给视图类的请求函数处理,获得请求的响应结果,返回给前台

相关文章
相关标签/搜索