Django REST framework实现api接口

这篇具有很好参考价值的文章主要介绍了Django REST framework实现api接口。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

drf 是Django REST framework的简称,drf 是基于django的一个api 接口实现框架,REST是接口设计的一种风格。

一、 安装drf

pip install djangorestframework
pip install markdown             # Markdown support for the browsable API.
pip install django-filter        # Filtering support

在django 上运行,首先要安装好django 和数据库驱动,后端接口就是对数据库资源的操作。

二、快速上手

restful 接口的规范:

/book/     GET         查看所有的资源,返回所有的资源
/book/     POST        添加资源,返回添加的资源
/book/1    GET         查看某个资源,返回这一个资源
/book/1    PUT         编辑某个资源,返回这编辑之后的这个资源
/book/1    DELETE      删除某个资源,返回空

实现get 查看所有资源

1、创建数据库表,在models.py中

from django.db import models

# Create your models here.

class Book(models.Model):
    title = models.CharField(verbose_name="书籍名称",max_length=32)
    price = models.DecimalField(verbose_name="价格",decimal_places=2,max_digits=6,null=Ture)
    pub_date = models.DateField(verbose_name="出版日期")

    def __str__(self):
        return self.title

要执行生成表的语句:

py -3 manage.py makemigrations
py -3 manage.py migrate

2、设置路由,在urls.py中


from django.contrib import admin
from django.urls import path
from app01 import views

urlpatterns = [
    path('book/', views.BookView.as_view()),

]

3、在视图函数中,views.py
首先要定义一个模型设计序列化器

from django.shortcuts import render
from rest_framework.views import APIView
from rest_framework import serializers
from rest_framework.response import Response
from app01 import models

# Create your views here.

class BookSerializers(serializers.Serializer):
    """针对模型设计序列化器"""
    title = serializers.CharField(max_length=32)
    # 默认字段都是必填字段,如果不填会报错,如果要变成可选字段可以加上required=False,该值就可以为空,但是要注意跟数据库的设计一致,数据库的该字段如果是可以为空,那么这里才可以设置字段为空
    price = serializers.DecimalField(max_digits=6,decimal_places=2,required=False)
    #如果想要返回的字段跟数据库的不一致,就需要指定source字段,在数据库中的原始字段名称, 接口返回给前端的是date
    date = serializers.DateField(source="pub_date")

class BookView(APIView):
    """book资源管理类"""

    def get(self,request):
        #获取所有的书籍
        book_list = models.Book.objects.all()
        #构建序列化器对象
        serializer = BookSerializers(instance=book_list,many=True)
        return Response(serializer.data)

4、测试接口
启动django项目
我是安装了一个apiforx的客户端,设置好协议和地址端口。
Django REST framework实现api接口,python,django
在apiforx 中调成调试模式,直接发送get请求,不需要任何参数,点击发送,可以看到返回了一个数组,里面嵌套了字典,这样一个简单的get 请求的接口就完成了。
Django REST framework实现api接口,python,django

实现post请求添加数据

post 请求还是在上面的BookView 中实现,请求的路径不变,只是请求的方式改变为post
在BookView 中增加一个post 方法:

class BookView(APIView):
    """book资源管理类"""

    def get(self,request):
        #获取所有的书籍
        book_list = models.Book.objects.all()
        #构建序列化器对象
        serializer = BookSerializers(instance=book_list,many=True)
        return Response(serializer.data)

    def post(self,request):
        #获取请求数据 {'title': '西厢记', 'price': 188.1, 'date': '2013-08-12'}
        #print(request.data)

        #构建序列化器对象
        serializer = BookSerializers(data=request.data)
        #校验数据
        if serializer.is_valid():  #返回一个布尔值,所有字段皆通过才返回True, serializer.validated_data, 否则返回False, 错误信息存在serializer.errors
            # 校验成功,将数据插入到数据库中
            models.Book.objects.create(**serializer.validated_data)
            return Response(serializer.data)
        #校验失败返回错误信息
        return Response(serializer.errors)

接口测试:
Django REST framework实现api接口,python,django

实现查询某一个资源

查询某一个资源的时候要是get 请求,只是路径后面要带一个id,这个时候就需要重新写一个路由了,因为一个类里面不能有两个get 方法
urls.py

from django.contrib import admin
from django.urls import path,re_path
from app01 import views

urlpatterns = [
    path('admin/', admin.site.urls),
    path('book/', views.BookView.as_view()),
    re_path('book/(\d+)', views.BookDetialView.as_view()),

]

views.py
重新写一个方法类BookDetialView

from django.shortcuts import render
from rest_framework.views import APIView
from rest_framework import serializers
from rest_framework.response import Response
from app01 import models

class BookSerializers(serializers.Serializer):
    """针对模型设计序列化器"""
    title = serializers.CharField(max_length=32)
    # 默认字段都是必填字段,如果不填会报错,如果要变成可选字段可以加上required=False,该值就可以为空,但是要注意跟数据库的设计一致,数据库的该字段如果是可以为空,那么这里才可以设置字段为空
    price = serializers.DecimalField(max_digits=6,decimal_places=2)
    #如果想要返回的字段跟数据库的不一致,就需要指定source字段,在数据库中的原始字段名称, 接口返回给前端的是date
    date = serializers.DateField(source="pub_date")

    def create(self, validated_data):
        new_list = models.Book.objects.create(**self.validated_data)
        return new_list

class BookView(APIView):
    """book资源管理类"""

    def get(self,request):
        #获取所有的书籍
        book_list = models.Book.objects.all()
        #构建序列化器对象
        serializer = BookSerializers(instance=book_list,many=True)
        return Response(serializer.data)

    def post(self,request):
        #获取请求数据 {'title': '西厢记', 'price': 188.1, 'date': '2013-08-12'}
        #print(request.data)

        #构建序列化器对象
        serializer = BookSerializers(data=request.data)
        #校验数据
        if serializer.is_valid():  #返回一个布尔值,所有字段皆通过才返回True, serializer.validated_data, 否则返回False, 错误信息存在serializer.errors
            # 校验成功,将数据插入到数据库中
            #models.Book.objects.create(**serializer.validated_data)
            serializer.save()
            return Response(serializer.data)

        return Response(serializer.errors)

class BookDetialView(APIView):
    def get(self,request,id):
        book = models.Book.objects.get(pk=id)

        #序列化传参instance ,反序列化传参data, 序列化是后端返回数据给前端,反序列化是后端接受数据
        serializer = BookSerializers(instance=book,many=False)
        return Response(serializer.data)

接口测试:
Django REST framework实现api接口,python,django文章来源地址https://www.toymoban.com/news/detail-675082.html

到了这里,关于Django REST framework实现api接口的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【后端】Django与Django REST Framework的结合使用

    提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 随着开发语言及人工智能工具的普及,使得越来越多的人会主动学习使用一些开发语言,本文主要介绍Django与Django REST Framework的结合使用。 创建Django项目通常包括以下步骤: 安装Django : 首先,确保你的

    2024年04月26日
    浏览(35)
  • 深入探索 Django Rest Framework

    这篇文章会详细介绍Django REST Framework的核心组成部分,包括Serializers、ViewSets、Routers、权限和认证系统以及测试和调试工具。文章从基础开始,逐步深入,旨在帮助读者掌握使用Django REST Framework构建复杂API的技能。 Django REST框架,通常简称为DRF,是一个强大而灵活的Web API工具

    2024年02月15日
    浏览(41)
  • django rest framework 学习笔记2

    注意:该文章部分摘抄之百度,仅当做学习笔记供小白使用,若侵权请联系删除! 显示关联表的数据,本示例会显示所有的关联的数据信息 读取到的结果器数据关联的为数字,此时需要进行一些操作可以读到正确数据 方法1: source=\\\'字段名.关联属性值\\\' 方法2 : 返回其属性值

    2024年02月20日
    浏览(38)
  • Django rest framework基本知识

    使用pycharm生成Django项目后,会生成工程目录和app目录 工程目录下5个文件,settings.py是全局配置相关的  urls.py是路有相关的 app相关的目录    models.py 数据库ORM对应的模型类  serializers.py 序列化与反序列化处理    views.py 根据request进行业务逻辑处理,返回response    admin.p

    2024年02月09日
    浏览(43)
  • Django Rest_Framework(一)

    在开发Web应用中,有两种应用模式: 前后端不分离[客户端看到的内容和所有界面效果都是由服务端提供出来的。] 前后端分离【把前端的界面效果(html,css,js分离到另一个服务端或另一个目录下,python服务端只需要返回数据即可)】 前端形成一个独立的网站/独立的地址,服

    2024年02月14日
    浏览(39)
  • Django Rest_Framework(三)

    为了方便接下来的学习,我们创建一个新的子应用 opt 注册子应用 总路由,代码: 子路由,代码: 因为接下来的认证组件中需要使用到登陆功能,所以我们使用django内置admin站点并创建一个管理员. admin运营站点的访问地址:http://127.0.0.1:8000/admin 创建管理员以后,访问admin站

    2024年02月14日
    浏览(51)
  • Django Rest_Framework(二)

    什么时候声明的序列化器需要继承序列化器基类Serializer,什么时候继承模型序列化器类ModelSerializer? 看数据是否从mysql数据库中获取,如果是则使用ModelSerializer,不是则使用Serializer drf除了在数据序列化部分简写代码以外,还在视图中提供了简写操作。所以在django原有的dja

    2024年02月14日
    浏览(35)
  • django rest framework 学习笔记-实战商城

     01项目环境搭建_哔哩哔哩_bilibili  本博客借鉴至大佬的视频学习笔记 创建apps文件夹放入的上面应用  创建shop数据库 mysql create database shop charset=utf8; Query OK, 1 row affected, 1 warning (0.01 sec)  公共表设计: 用户表结构设计  执行迁移文件,生成表结构 E:desktopmy_drfMyShoppython manag

    2024年02月22日
    浏览(44)
  • 使用Django Rest framework搭建Blog

    在前面的Blog例子中我们使用的是GraphQL, 虽然GraphQL的使用处于上升趋势,但是Rest API还是使用的更广泛一些. 所以还是决定回到传统的rest api framework上来, Django rest framework的官网上给了一个很好用的QuickStart, 我参考Quick Start将前面的Blog的例子用DRF(Django Rest Framework)重新构筑一遍

    2023年04月19日
    浏览(42)
  • Django_rest_framework-drf 笔记

    Django-drf-序列化器高级用法之SerializerMethodField - 知乎 (zhihu.com) 一句话: search_fields  里的字段,是做模糊查询的字段; filter_fields  里的字段,是做精确查询的字段。 科普search_fields与filter_fields的区别_空气中的臭氧的博客-CSDN博客 一句话: related_name = \\\'test\\\' publish_obj.test.all() 

    2024年02月16日
    浏览(38)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包