2021-5-17 ＜Django框架 五---接口开发＞

最新推荐文章于 2024-08-18 11:32:40 发布
最新推荐文章于 2024-08-18 11:32:40 发布
阅读量485 收藏 1
点赞数
分类专栏： Django 文章标签： python django
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41013021/article/details/117090722
版权

目录

 

动静分离

动静不分离

动静分离（前后端分离）

Restful与接口文档

CORS问题

FBV与CBV

F function（用的很少）

C class

Django-RESTfulFramewrok

安装

快速开始

    序列化：

            视图：

            路由：

动静分离

动：动态数据

静：静态文件

动静不分离

随着技术的发展：

  1. 前端技术越来越复杂，后端的学习成本变高了。

  2. 使用web技术终端变多了，比如：pc，小程序，移动端

动静分离（前后端分离）

Restful与接口文档

 

为了规范接口开发，后端工程师需要遵循RestFul风格和编写接口文档

Restful:（英文：Representational State Transfer，简称REST）是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义返回数据。

  1. API与用户的通信协议，总是使用HTTPS协议。

  2. 在域名上和常规的页面有区分，例如：

    https://www.ujiuye.com  网页地址
https://www.ujiuye.com/api/v1.0/  接口地址
  3. 规范：在url上不可以出现动词 
    对学员信息编写接口
https://www.ujiuye.com/api/v1.0/get_student/  get就是动词，不好
GET https://www.ujiuye.com/api/v1.0/student/  get请求方式，返回所有学员信息
GET https://www.ujiuye.com/api/v1.0/student/1/   get请求方式，返回id为1的学员信息
GET https://www.ujiuye.com/api/v1.0/student/?age=12   get请求方式，返回age为12的学员信息
POST https://www.ujiuye.com/api/v1.0/student/  post请求方式，保存学员形象
PUT https://www.ujiuye.com/api/v1.0/student/1/  put请求方式，修改id为1的学员信息
DELETE https://www.ujiuye.com/api/v1.0/student/1/  delete请求方式，删除id为1的学员

     

  4. 服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。 
    200 OK - [GET]：服务器成功返回用户请求的数据
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 - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

     

  5. 针对不同操作，服务器向用户返回的结果应该符合以下规范。 
    GET  /collection：返回资源对象的列表（数组）
GET  /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT  /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

     

  6. RESTful API最好做到Hypermedia（即返回结果中提供链接，连向其他API方法），使得用户不查文档，也知道下一步应该做什么。接口文档：网关：接口地址,比如：

    https://www.ujiuye.com/api/v1.0/

    接口描述：

    支持接口的功能和效果

    请求描述

    请求的格式，请求需要携带的参数，参数的含义

  7. 参考

    https://opendocs.alipay.com/apis

     

CORS问题

同源问题

一个源的定义：如果两个页面的协议，端口（如果有指定）和域名都相同，则两个页面具有相同的源。（举路由例子来说明）

同源策略：同源策略是浏览器的一个安全功能，不同源的客户端脚本在没有明确授权的情况下，不能读写对方资源。注意：浏览器只会阻止ajax和form请求，不会阻止src请求

接口地址：
https://inedx.com/api/v2.9
https://helloworld.com
这样：
https://helloworld.com的网页无法请求https://inedx.com/api/v2.9的数据，需要开发者手动解除同源问题。

方法1：

使用django-cors-headers方法

  1. 安装cors模块：pip install django-cors-headers
  2. 安装应用：settings当中INSTALLED_APPS部分添加：corsheaders
  3. settings当中MIDDLEWARE_CLASSES添加：'corsheaders.middleware.CorsMiddleware',
  4. 配置白名单：CORS_ORIGIN_WHITELIST
  5. 后端是否支持跨域的cookie的操作：CORS_ALLOW_CREDENTIALS
  6. 后端允许的请求方法：CORS_ALLOW_METHODS
  7. 后端允许的请求头内容：CORS_ALLOW_HEADERS

方法2：

response["Access-Control-Allow-Origin"] = "http://192.168.10.101:8080"
response["Access-Control-Allow-Credentials"] = "true"
responsereutrn response["Access-Control-Allow-Methods"] = "GET,POST"
response["Access-Control-Allow-Headers"] = "Origin,Content-Type,Cookie,Accept,Token"

 

FBV与CBV

F function（用的很少）

FBV：函数视图，视图功能是一个函数，编写简单，但是不适合复杂的代码。

from django.http import JsonResponse

def books(request):
    """
    FBV 函数视图
    :param request:
    :return:
    """
    return JsonResponse({"code": 200,"data": []})

C class

CBV: 类视图，使用类进行视图功能的编写，比较笨重。

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

class BookView(View):
    def __init__(self,**kwargs):
        super(BookView).__init__(**kwargs)
        self.result = {
            "code": 200,
            "data": [

            ]
        }
    def get(self,request):
        self.result["data"].append("get 请求")
        return JsonResponse(self.result)


    def post(self,request):
        self.result["data"].append("post 请求")
        return JsonResponse(self.result)

    def put(self,request):
        self.result["data"].append("put 请求")
        return JsonResponse(self.result)

    def delete(self,request):
        self.result["data"].append("delete 请求")
        return JsonResponse(self.result)

路由配置

from django.contrib import admin
from django.urls import path,re_path
from Dj.views import *
urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', BookView.as_view()),
]

接口辅助工具 postman：

类视图的csrf问题：

from django.views.decorators.csrf import csrf_exempt
#csrf_exampt 避免csrf保护
urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', csrf_exempt(BookView.as_view())),
    # path('books/', books),

]

完整的接口代码

class BookView(View):
    def __init__(self,**kwargs):
        super(BookView).__init__(**kwargs)
        self.result = {
            "code": 200,
            "data": [

            ]
        }
    def serialize_book(self,obj):
        result = {
            "id": obj.id,
            "title": obj.title,
            "author": obj.author,
            "type": obj.type,
            "description": obj.description,
            "public_time": obj.public_time,
            "picture": "http://127.0.0.1:8000" + obj.picture.url.replace("/media/","/static/")
        }
        return result

    def get(self,request,id = 0):
        """
        books/    返回所有书籍
        books/1   返回id为1的书籍
        :param request:
        :return:
        """
        if id:
            try:
                book = Books.objects.get(id = id)
            except Exception as e:
                self.result["code"] = 400
                self.result["data"].append(str(e))
            else:
                self.result["data"].append(
                    self.serialize_book(book)
                )
        else:
            search_key = request.GET.dict()
            books = Books.objects.filter(**search_key)
            self.result["data"] = [self.serialize_book(i) for i in books]
        return JsonResponse(self.result)

    def post(self,request):
        data = request.POST
        author = data.get("author")
        type = data.get("type")
        description = data.get("description")
        public_time = data.get("public_time")
        picture = request.FILES.get("picture")

        books = Books()
        books.author = author
        books.type = type
        books.description = description
        books.public_time = public_time
        books.picture = picture
        books.save()

        self.result["data"].append(
            self.serialize_book(books)
        )

        return JsonResponse(self.result)

    def put(self,request,id):
        """
        获取put数据
        """
        data = MultiPartParser(
            request.META,
            request,
            request.upload_handlers
        ).parse()[0].dict() #接收put数据

        books = Books.objects.filter(id = id) #查询
        books.update(**data) #更新

        self.result["data"] = [self.serialize_book(i) for i in books]

        return JsonResponse(self.result)

    def delete(self,request,id):
        try:
            book = Books.objects.get(id = id)
        except Exception as e:
            self.result["code"] = 400
            self.result["data"].append(str(e))
        else:
            book.delete()
        return JsonResponse(self.result)

Django-RESTfulFramewrok

通常三方开发的模块都是以django App的形式出现的。

Django-restframework是进行接口快速开发的Django插件，加快了开发效率，减少了代码重构的可能

安装

pip install djangorestframework

快速开始

1.  配置settings                             

 

2.  编写序列化文件                   

    

3.  编写类视图                               

 

4.  编写路由                                   

 

上述案例完成了最基本的项目功能，接下来需要了解以下内容

了解restful的三个部分

序列化：

序列化最先解决的是将ORM数据实例转换为字典类型的问题。但是在发展的过程当中发现，反序列化也很重要。

快速序列化，使用ModelSerializer，这个方法基础了基础的Serializer方法，实现了对数据模型的快速遍历。

restful反序列化实现了数据的校验

  1. 使用validate_字段 
    class BooksSerializer(serializers.Serializer):
    """
    完成关于项目的序列化
    """
    title = serializers.CharField()
    author = serializers.CharField()
    type = serializers.CharField()
    description = serializers.CharField()
    public_time = serializers.DateField()
    # picture = serializers.ImageField()
    def validate_title(self,value): #只能对对应的字段进行校验
        if "坏蛋" in value:
            raise serializers.ValidationError("敏感词错误")
        return value

     

  2. 使用validate 
    class BooksSerializer(serializers.Serializer):
    """
    完成关于项目的序列化
    """
    title = serializers.CharField()
    author = serializers.CharField()
    type = serializers.CharField()
    description = serializers.CharField()
    public_time = serializers.DateField()
    # picture = serializers.ImageField()
    def validate(self, attrs): #可以对当前序列化的所有字段校验
        print(attrs)

     

  3. 使用字段的validators属性 
    def title_valid(value):
    if "坏蛋" in value:
        raise serializers.ValidationError("敏感词错误")
    return value

class BooksSerializer(serializers.Serializer):
    """
    完成关于项目的序列化
    """
    title = serializers.CharField(validators=[title_valid])
    author = serializers.CharField()
    type = serializers.CharField()
    description = serializers.CharField()
    public_time = serializers.DateField()

     

视图：

在restful当中，将试图划分成了两个部分，一部分是配置部分，用来加载各种过滤器，比如分页，比如分组查询。另外的的一部分用来做具体功能的实现。掌握各种类的拼装

路由：

 

 

 

 

 

 

 

 

 

 

 

 

 

谢桥同学
关注
专栏目录
Django接口开发
markshui的博客
08-24 526
Django接口开发 一、前后端分离 传统开发模式 url -->> 视图函数（逻辑判断、调用数据库、渲染HTML）–>>向浏览器返回HTML页面。 项目后台的商品列表页面已经使用传统开发模式实现了 但是呢，有时候我们需要将这些内容在移动端（手机APP）或者的设备上显示。那怎么办呢？ 我们可以再编写一套后台逻辑给移动端使用。但是这样比较麻烦，工作量比较大。有没有更简单的方式呢？我们可以使用前后端分离开发模式 二、前后端分离模型 前后端分离模型指的是后端只负责返回数据，不再负责渲染
django-rest-framework-datatables：Django REST框架与Datatables之间的无缝集成
01-30
Django REST Framework是一个强大的、灵活的、用于构建Web API的框架。它简化了诸如序列化、认证、权限控制等复杂任务，使得开发者可以更专注于业务逻辑。DRF提供了一套完整的工具集，包括JSON响应格式、URL路由、...
Django框架实现简单的接口开发
飞扬的博客
06-24 1231
Django框架上进行GET请求接口开发示例
Python Web开发Django框架应用指导
最新发布
sinat_30844883的博客
08-18 1274
Django是使用Python语言编写的一个开源Web应用框架，它遵循MTV架构、鼓励快速开发，是当前较为流行的一种Web开发框架。
Django框架
m0_56477185的博客
03-04 539
框架介绍 MVT&MVC 知道了框架的意义，那么就很好阐述我们接下来要讲的Django，这个框架的设计模式，Django主要采用MVT模式 M-model：模型，操作数据库功能部分 V-View：视图，处理业务逻辑的位置，提取数据、获取用户数据等等操作都在这里 T-Template：模版，用来展示视图操作后的数据，也可以在模版中为用户提供表单，让用户可以提交数据 在其他语言框架中，还有另外一种盛行的模式，叫做MVC，类似与Django的MVT M-model：模型，和MVT的 m
用django写接口
jp的博客
10-20 736
用django写接口
django开发api接口
qq_17375491的博客
10-28 6183
环境准备： python3.8 django 3.0.6 pycharm 2020.1 1、准备工作 pip3 install django 2、开始代码 2.1、settiong文件配置 INSTALLED_APPS增加自己的app名称 ```python INSTALLED_APPS = ['small_api',] 需要部署到服务器上需要更改该配置，若不部署，则不用更改 ```python ALLOWED_HOSTS = ['*'] 2.2、增加urls文件配置 ```urlpatterns
django-rest-framework-msgpack：MessagePack支持Django REST框架
02-05
Django 是一个广泛使用的 Python Web 开发框架，它提供了丰富的功能和强大的工具来构建 web 应用。Django REST framework（简称DRF）是 Django 的一个扩展，专为构建高质量的 RESTful API 设计。它提供了一套全面的...
高效易用Django流程引擎源码 - django-lb-workflow
03-25
便捷性：基于Django框架，提供了一套简单易用的接口，使得流程引擎的嵌入和扩展变得更为便捷。 文件结构概览： - Python源文件：68个（.py） - HTML页面：30个（.html） - 文档：6个（.rst） - 模板文件：10个...
django-lb-workflow：适用于Django的可重用工作流库
02-04
`django-lb-workflow` 是一个专为Django框架设计的可重用工作流库，旨在帮助开发者在构建复杂业务系统时，轻松管理应用程序的状态流转和审批流程。这个库提供了强大的工作流引擎，使得开发人员可以定义、执行和跟踪...
jira-bot是基于python+django框架开发的一款关于JIRA系统自动通知系统。
09-29
jira-bot是基于python+django框架开发的一款关于JIRA系统自动通知系统。使用Python+Django开发的一个小工具，通过调用JIRA接口进行工作流状态查询，并将查询结果通过微信企业号接口发送给所对应的组。
Django如何开发简单的查询接口详解
01-01
前言 Django处理json也是一把好手，有时候在工作中各个部门都会提供自己的相关接口，但是信息也只是单方的信息，这时候需要运维将各个部门的信息进行集成，统一出一个查询接口或页面，方便其他部门同事使用，接下来就介绍一下Django如果操作json。 首先介绍一下通过url获取json的方法： import urllib2 我们的需求是做一个集成的信息查询系统，包括简单的IP信息查询（省份运营商等），以及设备信息（如果是登记在资产管理库中的），还有IP归属（是否是客户源站IP），以及是否为其他部门的存储IP，另外还有错误日志具体信息查询，等等功能，这些功能信息的提供分属于不同的部门，有的是给
使用Django开发REST 接口
xinxin957_的博客
08-23 358
使用Django开发REST 接口 我们以在Django框架中使用的图书英雄案例来写一套支持图书数据增删改查的REST API接口，来理解REST API的开发。 在此案例中，前后端均发送JSON格式数据。 # views.py from datetime import datetime class BooksAPIVIew(View): """ 查询所有图书、增加图书...
怎么写接口
热门推荐
9527
08-09 2万+
rest framework 工作当中，逐渐多的出现不使用页面展示数据，直接使用数据接口，这样的好处： 1、首先可以实现动静分离。将数据库和查询和页面渲染彻底分开。 2、网站可以支持脚本批量开发。 请求接口的方式 最原始的接口搭建是使用类视图搭建接口，后来发现接口规范很难约束。就有前辈写了接口框架，使用框架进行规范的接口开发。这个叫restful,django拥有restful的插件 django...
django 接口开发
weixin_40303822的博客
11-02 2177
接口开发转载自【秦无殇的博客】：https://www.cnblogs.com/webDepOfQWS/p/10693152.html 原文章贴在下面作为笔记，全程按照原文走下来，加上下面的各种错误的解决，顺便记录一下遇到的问题及解决方案： 各版本如下： centos:7.2 python:3.6.8(win10下是3.7，实测没问题) django:2.2 pymysql:0.9.3 先在win上进行的调试 【记录1】：setting.py文件中 ALLOWED_HOSTS = [’*’] # 允许任何I
基于Django的接口开发
gua_niu123的博客
11-26 713
文章目录 拿商品类视图举例 from django.http import JsonResponse from django.views import View from django.views.decorators.csrf import csrf_exempt from django.utils.decorators import method_decorator from Goods.models import Goods @method_decorator(csrf_exempt,"dispat
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值