Django REST framework学习记录，包括REST的基本用法，Django-filter实现筛选、查询、模糊查询等功能，实现分页，用Swagger生成api文档

已于 2024-04-16 17:27:54 修改
阅读量221 收藏 1
点赞数
分类专栏： python 文章标签： django 学习 python
于 2023-10-30 16:49:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/marker_sun/article/details/134059248
版权

文章目录

前言

这个文章，是我学习王进老师的课程的笔记，感谢王进老师。强烈推荐大家去看看王进老师的课程

第一步，安装和注册 Django REST Framework

可以通过 pip 来安装。最好在一个虚拟环境中进行操作，以隔离出您的项目所需的依赖项。

步骤如下：

  1. 打开终端或命令行界面。
  2. 进入您的项目虚拟环境。
  3. 运行以下命令来安装 Django REST Framework：
pip install djangorestframework
  1. 安装完成后，您需要将它添加到您的项目的 settings.py 文件中的 INSTALLED_APPS 中：
INSTALLED_APPS = [
    # ...
    'rest_framework',
]

这样，Django REST Framework 就已经被成功安装到您的项目中了。

第二步，增删改查的应用

1、rest的基本规范：

常用的HTTP请求方法有以下几种：

GET：获取资源的信息，可以理解为读取操作。
POST：创建资源，可以理解为写入操作。
PUT：更新资源，可以理解为更新操作。
DELETE：删除资源，可以理解为删除操作。
PATCH：更新资源的部分信息，可以理解为局部更新操作。

2、序列化

序列化，就是将django从数据库中取出的数据对象进行转换。即获取数据时，将对象转化为 json 格式传送给前端；存储时，将 json 格式转化为对象，写入数据中。
在 app 的文件夹中新建 “serializer.py” 文件，并在该文件中写入：

# ==========导入模块===========
from rest_framework import serializers
from studentweb.models import Faculty, Major, Student

# ==========Faculty 序列化类============
class FacultySerializer(serializers.Modelserializer):
	class Meta:
		model = Faculty
		fields = "__all__"

# ==========Major序列化类============
class MajorSerializer(serializers.Modelserializer):
	class Meta:
		model = Major
		fields = "__all__"

# ==========Student序列化类============
class StudentSerializer(serializers.Modelserializer):
	class Meta:
		model = Student
		fields = "__all__"

3、视图

实现后台的核心功能。基于 类 来实现
在views文件中写入：

# ============导入模块==================

from rest_framework.viewsets import ModelViewSet  # 封装完成的ModleViewset视图集
from studentweb.models import Faculty, Major, Student  # 导入数据类
from studentweb.serializer import FacultySerializer, MajorSerializer, StudentSerializer  # 导入序列化的数据类

# ================Faculty视图======================
class FacultyViewSet(ModelViewSet):
	queryset = Faculty.objects.all()
	serializer_class = FacultySerializer


# ================mojer视图======================
class MojerViewSet(ModelViewSet):
	queryset = Mojer.objects.all()
	serializer_class = MojerSerializer


# ================Student视图======================
class StudentViewSet(ModelViewSet):
	queryset = Student.objects.all()
	serializer_class = FacultySerializer

4、路由

在 “urls.py” 文件中配置路由

# =============导入模块===========
from django.urls import path
from rest_framework.routers import DefaultRouter
from studentweb.views import FacultyViewSet, MojerViewSet, StudentViewSet

urlpatterns = []

# ============1.实例化一个DefaultRouter=========
router = DefaultRouter()

# ============2.注册相应的url===================
# 注册 faculty 对象
router.register('facultys', FacultyViewSet, basename='facultys')

# 注册 major对象
router.register('majors', MajorViewSet, basename='majors')

# 注册 student 对象
router.register('students', StudentViewSet, basename='students')

# ============3.附加到urlpatterns集合中=========
urlpatterns += router.urls

第三步，实现筛选

1、安装 django-filter 并注册

可以通过 pip 来安装。最好在一个虚拟环境中进行操作，以隔离出您的项目所需的依赖项。

步骤如下：

  1. 打开终端或命令行界面。
  2. 进入您的项目虚拟环境。
  3. 运行以下命令来安装 Django-filter：
pip install django-filter
  1. 安装完成后，您需要将它添加到您的项目的 settings.py 文件中的 INSTALLED_APPS 中：
INSTALLED_APPS = [
    # ...
    'django_filters',
]

这样，Django REST Framework 就已经被成功安装到您的项目中了。

2、完成筛选的类

在 app 的文件夹中，新建一个**“filter.py”**的文件，用来存放筛选的类
在改文件中写入以下内容

# =========导入模块============
from django_filters import FilterSet
from studentweb.models import Faculty, Major, Student  # 导入数据类

# ============faculty的filter类========
class FacultyFilter(FilterSet):
	class Meta:
		model = Faculty
		fields = ("name",) # 注意，在元组中，如果只有一个元素，一定要加 “，”,不然会报错

# ============major的filter类========
class MajorFilter(FilterSet):
	class Meta:
		model = Major
		fields = ("name", "faculty")

# ============student的filter类========
class StudentFilter(FilterSet):
	class Meta:
		model = Student
		fields = ("sno", "name", "moble")

3、将筛选类“filter.py”导入到视图（views.py）中

在views文件中写入：

# ============导入模块==================

from rest_framework.viewsets import ModelViewSet  # 封装完成的ModleViewset视图集
from studentweb.models import Faculty, Major, Student  # 导入数据类
from studentweb.serializer import FacultySerializer, MajorSerializer, StudentSerializer  # 导入序列化的数据类

#  以下是新增的
from django_filters.rest_framework import DjangoFilterBackend # 实现筛选的后台模块
from studentweb.filter import FacultyFilter, MajorFilter, StudentFilter #  导入筛选类

# ================Faculty视图======================
class FacultyViewSet(ModelViewSet):
	queryset = Faculty.objects.all()
	serializer_class = FacultySerializer
	
	# 设定筛选的后台,由于这一行代码，是筛选的必须，所以，可以在“setting.py”中设置全局属性，以省略这一行代码
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = FacultyFilter


# ================mojer视图======================
class MojerViewSet(ModelViewSet):
	queryset = Mojer.objects.all()
	serializer_class = MojerSerializer

	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = MajorFilter


# ================Student视图======================
class StudentViewSet(ModelViewSet):
	queryset = Student.objects.all()
	serializer_class = FacultySerializer
	
	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = StudentFilter

在**“setting.py”**中添加以下设置，进行全局设定，就不用在每一个视图函数中增加以下代码filter_backends = (DjangoFilterBackend, )

# ===========REST Framework全局设置============
REST_FRAMEWORK = {

	# 设置全局的Filter Backends
	'DEFAULT_FILTER_BACKENDS' : [
		'django_filters.rest_framework.DjangoFilterBackend',
	]
}

4、 优化筛选，实现模糊查询

之前的步骤完成后，就已经可以实现筛选功能了，但是，之前的只支持精准查询，不能实现模糊查询，这里就是进一步优化，实现模糊查询功能。在**“filter.py”**文件中重写需要模糊查询的字段

# =========导入模块============
from django_filters import FilterSet
from studentweb.models import Faculty, Major, Student  # 导入数据类

# ============faculty的filter类========
class FacultyFilter(FilterSet):
	# 重新写需要模糊查询的字段
	name = filters.CharFilter(field_name="name", lookup_expr="icontains")
	
	class Meta:
		model = Faculty
		fields = ("name",) # 注意，在元组中，如果只有一个元素，一定要加 “，”,不然会报错

# ============major的filter类========
class MajorFilter(FilterSet):
	class Meta:
		model = Major
		fields = ("name", "faculty")

# ============student的filter类========
class StudentFilter(FilterSet):
	class Meta:
		model = Student
		fields = ("sno", "name", "moble")

第四步，实现查询（搜索）功能

筛选是匹配一个字段，而查询（搜索），则是匹配多个字段的。

1、在 views.py 中写入以下代码：

# ============导入模块==================

from rest_framework.viewsets import ModelViewSet  # 封装完成的ModleViewset视图集
from studentweb.models import Faculty, Major, Student  # 导入数据类
from studentweb.serializer import FacultySerializer, MajorSerializer, StudentSerializer  # 导入序列化的数据类


from django_filters.rest_framework import DjangoFilterBackend # 实现筛选的后台模块
from studentweb.filter import FacultyFilter, MajorFilter, StudentFilter #  导入筛选类

from rest_framework.filter import SearchFilter # 导入搜索的后台功能

# ================Faculty视图======================
class FacultyViewSet(ModelViewSet):
	queryset = Faculty.objects.all()
	serializer_class = FacultySerializer
	
	# 设定筛选的后台,由于这一行代码，是筛选的必须，所以，可以在“setting.py”中设置全局属性，以省略这一行代码。
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = FacultyFilter


# ================mojer视图======================
class MojerViewSet(ModelViewSet):
	queryset = Mojer.objects.all()
	serializer_class = MojerSerializer

	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = MajorFilter


# ================Student视图======================
class StudentViewSet(ModelViewSet):
	queryset = Student.objects.all()
	serializer_class = FacultySerializer
	# 设置查找的后台功能,在filter_backends元组中添加“SearchFilter”。如果筛选设置了全局，那么搜索也要在全局设置
	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, SearchFilter) # 这里需要注意，因为是元祖，所以只有一个元素时，需要在元素后面加 “，”
	# 指定筛选的类
	filter_class = StudentFilter
	# 指定需要查询（搜索）的字段
	search_fields = ("sno", 'name', 'moble')

2、在**“setting.py”**中添加以下设置

进行全局设定，就不用在每一个视图函数中增加以下代码filter_backends = (DjangoFilterBackend, SearchFilter)

# ===========REST Framework全局设置============
REST_FRAMEWORK = {

	# 设置全局的Filter Backends
	'DEFAULT_FILTER_BACKENDS' : [
		'django_filters.rest_framework.DjangoFilterBackend',
		'rest_framework.filters.SearchFilter',
	]
}

第五步，实现分页

1、单独设置的方法

  • 在 app 的文件夹中，新建一个“paginations.py”的文件，用来存放筛选的类
    在改文件中写入以下内容
# ===========导入模块=============
from rest_framework.pagination import PageNumberPagination

class MyPageNumberPagination(PageNumberPagination):
	page_size = 5  # 默认的每页数量
	page_query_param = "page"  # 默认的页码的参数名
	page_size_query_param = "size"  # 默认的每页数量的参数名
	max_page_size = 10  # 设置每页最大数量
  • 在 “views.py” 中引用并配置
# ============导入模块==================

from rest_framework.viewsets import ModelViewSet  # 封装完成的ModleViewset视图集
from studentweb.models import Faculty, Major, Student  # 导入数据类
from studentweb.serializer import FacultySerializer, MajorSerializer, StudentSerializer  # 导入序列化的数据类


from django_filters.rest_framework import DjangoFilterBackend # 实现筛选的后台模块
from studentweb.filter import FacultyFilter, MajorFilter, StudentFilter #  导入筛选类

from rest_framework.filter import SearchFilter # 导入搜索的后台功能

from studentweb.paginations import MyPageNumberPagination

# ================Faculty视图======================
class FacultyViewSet(ModelViewSet):
	queryset = Faculty.objects.all()
	serializer_class = FacultySerializer
	
	# 设定筛选的后台,由于这一行代码，是筛选的必须，所以，可以在“setting.py”中设置全局属性，以省略这一行代码。
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = FacultyFilter


# ================mojer视图======================
class MojerViewSet(ModelViewSet):
	queryset = Mojer.objects.all()
	serializer_class = MojerSerializer

	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = MajorFilter


# ================Student视图======================
class StudentViewSet(ModelViewSet):
	queryset = Student.objects.all()
	serializer_class = FacultySerializer
	# 设置查找的后台功能,在filter_backends元组中添加“SearchFilter”。如果筛选设置了全局，那么搜索也要在全局设置
	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, SearchFilter) # 这里需要注意，因为是元祖，所以只有一个元素时，需要在元素后面加 “，”
	# 指定筛选的类
	filter_class = StudentFilter
	# 指定需要查询（搜索）的字段
	search_fields = ("sno", 'name', 'moble')
	# 增加分页
	pagination_class = MyPageNumberPagination

2、设置全局的方法在**“setting.py”**中添加以下设置

# ===========REST Framework全局设置============
REST_FRAMEWORK = {

	# =======设置全局的Filter Backends==========
	'DEFAULT_FILTER_BACKENDS' : [
		'django_filters.rest_framework.DjangoFilterBackend',
		'rest_framework.filter.SearchFilter',
	]，
	# ======设置分页=========
	'DEFAULT_PAGINATION_CLASS' : 'rest_framework.pagination.PageNumberPagination',
	'PAGE_SIZE' : 10
}

第六步，生成API文档

可选的有：

  1. CoreAPI --------------------- 注：这个库已经不更新了
  2. Swagger---------------------注：推荐使用这个

1、安装并注册

pip install drf-yasg

INSTALLED_APPS = [
    # ...
    'drf-yasg',
]

2、在最外层的urls.py中配置

from django.contrib import admin
from django.urls import path, include

from drf_yasg.views import get_schema_view
from drf_yasg import openapi

schema_view = get_schema_view(
	openapi.Info(
		title = "API借口文档平台",  # 必须参数
		default_version = "V1",  # 必须参数
		description = "这是一个接口文档",
		terms_of_service = "",
		contact = openapi.Contact(email=""),
		license = openapi.License(name="BSD License"),
	),
	public = True,
	# permission_classes = (permissions.AllowAny,), # 权限类
)

urlpatterns = [
	path("admin/", admin.site.urls),
	path("api/v1/", include('studentweb.urls')),
	
	# 配置API文档的路径
	path("docs", schema_view.with_ui('swagger', cache_timeout=0), name="schema-swagger-ui")
]

3、使文档显示中文

在 views.py 文件中，为每一个类添加一个注释，即可完成。例如：

# ============导入模块==================

from rest_framework.viewsets import ModelViewSet  # 封装完成的ModleViewset视图集
from studentweb.models import Faculty, Major, Student  # 导入数据类
from studentweb.serializer import FacultySerializer, MajorSerializer, StudentSerializer  # 导入序列化的数据类

#  以下是新增的
from django_filters.rest_framework import DjangoFilterBackend # 实现筛选的后台模块
from studentweb.filter import FacultyFilter, MajorFilter, StudentFilter #  导入筛选类

# ================Faculty视图======================
class FacultyViewSet(ModelViewSet):
	queryset = Faculty.objects.all()
	serializer_class = FacultySerializer
	
	# 设定筛选的后台,由于这一行代码，是筛选的必须，所以，可以在“setting.py”中设置全局属性，以省略这一行代码
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = FacultyFilter


# ================mojer视图======================
class MojerViewSet(ModelViewSet):
	queryset = Mojer.objects.all()
	serializer_class = MojerSerializer

	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = MajorFilter


# ================Student视图======================
class StudentViewSet(ModelViewSet):
	"""
	create:
	创建学生信息
	update:
	完整更新学生信息
	partial_update:
	部分更新学生信息
	destroy:
	删除学生信息
	list:
	获取所有学生信息
	"""
	queryset = Student.objects.all()
	serializer_class = FacultySerializer
	
	# 设定筛选的后台
	filter_backends = (DjangoFilterBackend, ) # 这里需要注意，因为是元祖，所以需要在每一个元素后面加 “，”
	# 指定筛选的类
	filter_class = StudentFilter
marker_sun
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
自动管理接口文档：Django中的API文档自动生成
TtqdAbap的博客
09-17 337
这个页面列出了你的应用程序中的所有API视图，并提供了每个视图的详细信息，包括请求和响应的数据结构、方法和URL。AutoSchema类将解析我们在API视图函数中编写的文档字符串，并生成相应的API文档。我们可以创建一个简单的API视图，该视图将返回包含API文档的HTML页面。在上述例子中，我们创建了一个名为api_root的API根视图，它返回一个包含example视图URL的响应。每当我们更新API视图或添加新的API视图时，文档也会自动更新，确保我们的API文档始终与应用程序保持同步。
django-rest-framework 官方文档
01-31
Django REST Framework拥有丰富的第三方扩展，如drf-extensions、drf-yasg（用于生成Swagger UI文档）等，可以进一步增强功能。 总之，Django REST Framework是构建高质量、可维护的RESTful API的理想选择。通过...
Django Rest Framework 3.8 自动生成 API 文档
热门推荐
刘延林
05-17 1万+
使用 Django Rest Framework 3.8 自动生成 API 文档原文地址：https://www.jianshu.com/p/dc77f652e7d7pip install djangorestframework pip install markdown pip install django-filter pip install django-rest-swaggerdjango-...
django-rest-framework 自动生成api文档
smartwu_sir的博客
05-06 6745
django-rest-framework 自动生成文档（用django-rest-framework自带的和第三方包swagger） 1. 准备工作 pip install coreapi pip install django-rest-swagger 2. 配置 用django自带的（界面没有swagger好看，功能差不多，不推荐） # urls.py from r...
django rest_framework自动生成接口API文档
yb389973788的博客
08-10 542
1、安装coreapi包 2、项目目录中的urls中增加 from rest_framework.documentation import include_docs_urls path('docs/', include_docs_urls(title='API文档')), 2、项目setting中增加 REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema' }
Django restful framework中自动生成API文档
a9794666的博客
08-14 383
自动生成api文档（不管是函数视图还是类视图都能显示） 1.安装rest_framework_swagger库 pip install django-rest-swagger 2.在项目下的 urls.py 中加入如下： from rest_framework_swagger.views import get_swagger_view schema_view =...
django rest framework 使用api接口文档
运维求生之路
07-31 2384
1、pip install django-rest-swagger 2、url.py中配置 from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title='API 接口文档') urlpatterns = [ path('docs/', schema_view, name='docs'), # 线上环境中，最好去掉 ] 3、在settings.py中添加下列配置 R
Django REST framework框架手册
12-08
**Django REST Framework (DRF) 框架详解** Django REST Framework（简称DRF）是一个强大的、灵活的用于构建Web API的Python框架。它建立在Django之上，为开发高质量、可维护的API提供了丰富的工具集。下面将详细...
Django-Full-Rest-Framework-Practice:这里显示了Django Rest Framework Code示例的所有方法
03-31
Django Rest Framework（DRF）是基于Python的Web开发框架Django的一个强大扩展，它为构建RESTful API提供了丰富的工具集。在这个名为"Django-Full-Rest-Framework-Practice"的项目中，开发者可以深入理解并实践如何...
基于django restframework.zip
最新发布
04-26
【标题】：基于Django REST framework的Web API开发实践 【描述】：本项目是针对毕业设计而构建的一个示例，主要使用了Python的Django框架以及其扩展库Django REST framework来开发RESTful风格的Web API。Django ...
利用django自带的filte实现精准、模糊查询
07-11
利用django自带的filte实现精准、模糊查询，包括复选框多值准确查询，输入框精准和模糊查询，日期区间查询。
Django_Rest_Framework_API-:Django Rest Framework API
03-14
**Django Rest Framework API 深度解析** Django Rest Framework（DRF）是一个强大的、灵活的、用于构建Web API的高级框架，它基于Python语言，是Django Web框架的一个扩展。DRF允许开发者以简洁、高效的方式创建...
django-filter过滤查找（模糊查询）
qq_43665151的博客
03-13 5504
1.安装 pip insall django-filter django-filters⽀持的pytho和django版本： Python: 3.5, 3.6, 3.7, 3.8 Django: 1.11, 2.0, 2.1, 2.2, 3.0 DRF: 3.10+ 2.settings中配置 INSTALLED_APPS = [ ... 'django_filters', # 需要注册应⽤...
filter模糊查询
YuT_ian的博客
01-29 1003
<template> <div id="app"> <input oninput="search" type="text" v-model="input" /> <ul> <li class="search-item border-bottom" v-for="item of search" :key="item.name" >{{item.name}}&l
Django-REST-Framework 如何快速生成Swagger, ReDoc格式的 REST API 文档
Python技术探索
12-25 844
本文描述了Django-REST-Framework DRF项目如何自动生成 Swagger, ReDoc格式API, drf-yasg库的使用，以及DRF内置API文档生成工具的使用。
利用filter实现模糊查询
IT小小酥的博客
08-13 6167
       前端很多时候要实现模糊查询的效果，之前在网上搜模糊查询的时候，发现方法都比较麻烦，于是便写了这个比较简单的模糊查询。 上面是简单的页面，要求列表内容根据输入框的值进行匹配。 页面结构： &lt;div class="search_box"&gt;&lt;input type="text" placeholder="请输入您要查找的内容" autocomplete="off...
Django3 模糊查询/filters.SearchFilter的使用,基于viewsets.ModelViewSet
Franciz777的博客
07-24 1223
Django3 模糊查询的使用,基于viewsets.ModelViewSet
Swagger2使用时数据库模糊查询无法实现
clxve的博客
06-27 267
Swagger2使用时出现数据库模糊查询无法实现的问题。
django-rest-framework实现数据的过滤、搜索、排序
weixin_42289273的博客
12-29 1607
过滤 （1）如果进行条件过滤，需要首先安装django-filter模块： pip install django-filter （2）在配置文件settings.py中添加应用django_filters： INSTALLED_APPS = [ ...... 'apps.assets.apps.AssetsConfig', "rest_framework", "django_filters", ] （3）在apps/assets/views.py导入包：...
django rest-framework模糊查询
04-04
在Django Rest Framework中，可以使用`SearchFilter`类来实现模糊查询。`SearchFilter`类是DRF提供的一个过滤器类，可以通过对查询字符串进行分析，对指定的字段进行模糊匹配。 1. 在视图类中添加`SearchFilter`...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值