Django-rest framework框架的安装配置、简介、Web API接口和Restful接口规范、基于原生django书写满足restful规范的接口

目录

Django-rest framework框架的安装配置、简介、Web API接口和Restful接口规范、基于原生django书写满足restful规范的接口

drf框架安装配置

一.安装

pip3 install djangorestframework

二.配置

# 注册drf app
INSTALLED_APPS = [
    # ...
    'rest_framework',
]

三.特点

# 具体功能在具体模块下
from rest_framework.request import Request
from rest_framework.response import Response
from rest_framework.exceptions import APIException
from rest_framework.filters import OrderingFilter
from rest_framework.views import APIView
from rest_framework.pagination import PageNumberPagination
from rest_framework.settings import APISettings

# 自定义drf配置 - 在自己的settings.py
REST_FRAMEWORK = {
    # 自定义修改drf的配置们
}

什么是drf框架

一、drf优点

1. Django-rest framework可以帮助我们简化以下两部分的代码编写，大大提高REST API的开发速度。

  • 在序列化与反序列化时，虽然操作的数据不尽相同，但是执行的过程却是相似的，也就是说这部分代码是可以复用简化编写的。
  • 在开发REST API的视图中，虽然每个视图具体操作的数据不同，但增、删、改、查的实现流程基本套路化，所以这部分代码也是可以复用简化编写的。
    • 增：校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
    • 删：判断要删除的数据是否存在 -> 执行数据库删除
    • 改：判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
    • 查：查询数据库 -> 将数据序列化并返回

2. Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。通常简称为DRF框架或REST framework。

3. DRF框架是建立在Django框架基础之上，由Tom Christie大牛二次开发的开源项目。

二、特点

  • 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
  • 提供了丰富的类视图、Mixin扩展类，简化视图的编写；
  • 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
  • 多种身份认证和权限认证方式的支持；
  • 内置了限流系统；
  • 直观的 API web 界面；
  • 可扩展性，插件丰富

接口规范

drf框架的作用：写接口

Web API 接口

什么是Web API接口

Web API接口就是通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介。

明确了请求方式，提供对应后台所需参数，请求url链接可以得到后台的响应数据。

怎么写接口

参照某种规则(规范)书写url链接，同时根据规则制定请求方式，请求数据与响应结果。

接口的四个核心部分：请求方式、请求地址、请求参数、响应结果。

Web API接口的四大特点

Web API接口和一般的url链接还是有区别的，Web API 接口简单概括有下面四大特点

  • url：长得像返回数据的url链接

  • 请求方式：get(取)、post(增)、put(整体改)、patch(局部改)、delete(删除)

    • 采用get方式请求上方接口

  • 请求参数：json或xml格式的key-value类型数据

    • ak：6E823f587c95f0148c19993539b99295
    • region：上海
    • query：肯德基
    • output：json

  • 响应结果：json或xml格式的数据

    • 上方请求参数的output参数值决定了响应数据的格式

    • # 网络状态码：200
{
    "status": 0,
    "msg": "ok",
    "results": [
        {
            "name": "西游记",
            "img": "https://api.oldboy.com/media/img/xyj.png"
        }
    ]
}

接口文档的编写：YApi 接口管理平台

接口文档：提供给前后台开发人员与测试人员查看

YApi是去哪网大前端技术中心的一个开源可视化接口管理平台。

YApi项目可以搭建在任何本地或云服务器上，完成后台项目开发时的接口编写。为开发、测试等人员提供可视化的接口预览。

YApi进行接口编写的步骤：

  • 访问测试网站
  • 创建接口项目
  • 创建接口
  • 编写接口

接口测试工具：Postman

Postman是一款接口调试工具，是一款免费的可视化软件，同时支持各种操作系统平台，是测试接口的首选工具。

Postman可以直接从官网：https://www.getpostman.com/downloads/ 下载获得，然后进行傻瓜式安装。

Restful 接口规范

Restful 作为目前最流行的API设计规范，一定有着它独有的魅力：强大、简洁、易上手。

URL设计

数据的安全保障

url链接一般都采用https协议进行传输。

​ 注：采用https协议，可以提高数据交互过程中的安全性

接口特征表现

要用api关键字标识接口url：

上面两种形式都可以

​ 注：看到api字眼，就代表该请求url链接是完成前后台数据交互的。

多数据版本共存

要在url链接中标识数据版本

​ 注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本的情况下）

数据即是资源

接口一般都是完成前后台数据的交互，交互的数据称之为资源。

eg:

注：一般提倡用资源的复数形式，在url链接中尽量不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user

特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义：

资源操作方式由请求方式决定

操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作

eg:

响应状态码

正常响应

响应状态码2xx：

  • 200：常规请求
  • 201：创建成功

重定向响应

响应状态码3xx：

  • 301：永久重定向
  • 302：暂时重定向

客户端异常

响应状态码4xx：

  • 403：请求无权限
  • 404：请求路径不存在
  • 405：请求方法不存在

服务器异常

响应状态码5xx：

  • 500：服务器异常

响应结果

响应数据要有状态码、状态信息以及数据本身

{
     "status":0,    //状态响应码
     "message":"ok",    //状态信息
     "results":[    //响应数据
     {
         "name":"肯德基(罗餐厅)",
         "location":{
             "lat":31.415354,
             "lng":121.357339
            },
         "address":"月罗路2380号",
         "province":"上海市",
         "city":"上海市",
         "area":"宝山区",
         "street_id":"339ed41ae1d6dc320a5cb37c",
         "telephone":"(021)56761006",
         "detail":1,
         "uid":"339ed41ae1d6dc320a5cb37c"
     }
     ...
     ]
}

需要url请求的资源需要访问资源的请求链接

{
    "status": 0,
    "msg": "ok",
    "results":[
        {
            "name": "肯德基",
            "img": "https://image.baidu.com/kfc/001.png"
        }
    ]
}

基于原生django书写满足restful规范的接口

两个url 对应 一个视图类 完成十大接口，用到路由分发

路由分发需要在app文件夹下也创建一个urls.py文件

项目名下的urls.py

from django.conf.urls import url, include
from django.contrib import admin
from api import views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^test/', views.Test.as_view()),
    # 路由分发
    url(r'^api/', include('api.urls')),
]

app名下的urls.py：apiurls.py

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^books/$', views.Book.as_view()),    # 群查
    url(r'^books/(?P<pk>d+)/$', views.Book.as_view()),   # 单查
]

上面两个url都对应视图函数文件内的视图类Book

view.py

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

class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk', None)
        if pk:  # 单查
            book_dic = models.Book.objects.filter(pk=pk).values('name', 'price').first()
            results = book_dic
        else:  # 群查
            book_query = models.Book.objects.values('name', 'price')
            results = list(book_query)
        if not results:
            return JsonResponse({
                'status': 1,
                'msg': 'data error',
            })
        return JsonResponse({
            'status': 0,
            'msg': 'ok',
            'results': results
        })

CBV请求生命周期

as_view()方法完成路由匹配 => url请求会调用as_view()的返回值视图函数view => 调用dispatch()方法完成请求分发 => 视图类的具体视图方法处理请求 => 返回给前台

【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/zhuangyl23/p/11891795.html