Django REST Framework Dataclasses 项目教程

于 2024-08-30 09:37:12 发布
阅读量182 收藏 2
点赞数 2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gitblog_00412/article/details/141707335
版权

Django REST Framework Dataclasses 项目教程

djangorestframework-dataclassesDataclasses serializer for Django REST framework项目地址:https://gitcode.com/gh_mirrors/dj/djangorestframework-dataclasses

1. 项目的目录结构及介绍

djangorestframework-dataclasses/
├── rest_framework_dataclasses/
│   ├── __init__.py
│   ├── fields.py
│   ├── serializers.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_serializers.py
│   └── ...
├── pyproject.toml
├── README.rst
├── CHANGELOG.rst
└── LICENSE
  • rest_framework_dataclasses/: 包含项目的主要代码文件。
    • __init__.py: 模块初始化文件。
    • fields.py: 定义数据字段。
    • serializers.py: 定义序列化器。
  • tests/: 包含项目的测试文件。
    • __init__.py: 测试模块初始化文件。
    • test_serializers.py: 序列化器的测试文件。
  • pyproject.toml: 项目的配置文件。
  • README.rst: 项目说明文档。
  • CHANGELOG.rst: 项目更新日志。
  • LICENSE: 项目许可证。

2. 项目的启动文件介绍

项目的主要启动文件位于 rest_framework_dataclasses/ 目录下。关键文件包括：

  • fields.py: 定义了用于序列化和反序列化的数据字段。
  • serializers.py: 定义了用于处理数据序列化和反序列化的序列化器。

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml，其中包含了项目的基本信息和依赖项。以下是配置文件的部分内容：

[build-system]
requires = ["setuptools >= 61", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "djangorestframework-dataclasses"
version = "1.3.1"
description = "A dataclasses serializer for Django REST Framework"
readme = "README.rst"
license = { file = "LICENSE" }
authors = [ { name = "Oxan van Leeuwen", email = "oxan@oxanvanleeuwen.nl" }]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Web Environment",
    "Framework :: Django",
    "Framework :: Django :: 3.2",
    "Framework :: Django :: 4.0",
    "Framework :: Django :: 4.1",
    "Framework :: Django :: 4.2",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: BSD License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3.7",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: Internet :: WWW/HTTP",
    "Topic :: Software Development :: Libraries :: Application Frameworks",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Typing :: Typed"
]
requires-python = ">= 3.7"
dependencies = [
    "django >= 2.0",
    "djangorestframework >= 3.9",
    "typing_extensions >= 3.7.4; python_version < '3.8'"
]

[project.optional-dependencies]
dev = [
    "django-stubs",
    "djangorestframework-stubs",
    "mypy ~= 1.8.0"
]
test = [
    "coverage[toml]",
    "tox"
]
  • [build-system]: 定义了构建系统的要求和后端。
  • [project]: 包含了项目的基本信息，如名称、版本、描述、许可证、作者等。
  • [project.optional-dependencies]: 定义了可选的依赖项，如开发和测试所需的依赖。

djangorestframework-dataclassesDataclasses serializer for Django REST framework项目地址:https://gitcode.com/gh_mirrors/dj/djangorestframework-dataclasses

侯天阔Kirstyn
关注
  • 2
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Django Rest Framework框架
hehui1uu的博客
09-07 296
注明 本笔记主要参考书籍《Django应用开发实战》《Django企业开发实战》,这两本书前者详细，后者精炼。本文还主要参考(?雾)金角大王的博客，当然还参考了其他人的博客。这些文章很值得一读，开始我对这部分很懵懂，仔细研究这些文章之后有很大提升。差点忘记了我还参考了一些Rest Framework框架的手册。如果你遇到了值得一读的书籍，欢迎推荐给我，大家共同进步。 文章目录注明前言一、RESTful是什么对于API的误区Restful API设计指导HTTP动词过滤信息（Filtering）状态码（St
django rest framework vue 实现用户登录详解
09-18
首先，我们要了解Django REST framework以及Vue.js是什么。Django REST framework是一个强大且灵活的工具，用于构建Web API。Vue.js则是一个渐进式JavaScript框架，用于构建用户界面。将这两个技术结合起来实现用户...
挑战全网最全之django REST framework（DRF）教程
热门推荐
Timmy的博客
04-26 3万+
一、认识DRF 1、restful简介 在前后端分离的应用模式中，我们通常将后端开发的每个视图都称为一个接口，或者API，前端通过访问接口来对数据进行增删改查。 restful是一种后端API接口规范 1.1 http动词 对于资源的具体操作类型，由HTTP动词表示。 常用的HTTP动词有下面四个（括号里是对应的SQL命令）： GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器新建一个资源。 PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
Django REST framework 简介与中文教程
qq_42269354的博客
04-23 1479
Django REST framework 简介与中文教程 简介 在序列化与反序列化时，虽然操作的数据不尽相同，但是执行的过程却是相似的，也就是说这部分代码是可以复用简化编写的。 在开发REST API的视图中，虽然每个视图具体操作的数据不同，但增、删、改、查的实现流程基本套路化，所以这部分代码也是可以复用简化编写的： 增：校验请求数据–>执行反序列化过程–>保存数据库–>将...
探索高效数据序列化：Django REST Framework Dataclasses 序列化器
gitblog_01117的博客
08-29 554
探索高效数据序列化：Django REST Framework Dataclasses 序列化器 djangorestframework-dataclassesDataclasses serializer for Django REST framework项目地址:https://gitcode.com/gh_mirrors/dj/djangorestframework-dataclasses ...
Django Rest Framework框架 呼啦圈项目实战
王大阳的博客
06-18 1248
初识drf
django rest framework 学习笔记
种一棵树，最好的结果是十年前，其次是现在！
01-21 605
当用户进行登录的时候，运行了登录类的as_view()方法，进入了APIView类的dispatch方法 执行self.initialize_request这个方法，里面封装了request和认证对象列表等其他参数。校验数据，因为Excel表格里的数据没有约束，经常会出现数据不符合数据表字段约束条件的情况，若不校验会导致大量数据读出来以后存数据库时报错，导致写进数据库的操作失败！当您需要处理大型文件或数据时，生成器函数非常有用，因为它们可以在需要时按块生成数据，并且可以避免一次性加载大量数据到内存中。
[转]Django REST framework 简介与中文教程
江州司马
01-13 931
Django REST framework 简介与中文教程 简介 在序列化与反序列化时，虽然操作的数据不尽相同，但是执行的过程却是相似的，也就是说这部分代码是可以复用简化编写的。 在开发REST API的视图中，虽然每个视图具体操作的数据不同，但增、删、改、查的实现流程基本套路化，所以这部分代码也是可以复用简化编写的： 增：校验请求数据–>执行反序列化过程–>保存数据库–>将保存的对象序列化并返回； 删：判断要删除的数据是否存在–>执行数据库删除 改...
Django REST framework SimpleJWT 使用教程
gitblog_00580的博客
08-22 642
Django REST framework SimpleJWT 使用教程 djangorestframework-simplejwtA JSON Web Token authentication plugin for the Django REST Framework.项目地址:https://gitcode.com/gh_mirrors/dj/djangorestframework-simpl...
django restframework（上）
m0_66331988的博客
08-03 831
django restframework（简称drf）本质上其实就是一个别人编写好的app，里面集成了很多编写restful API的功能功能，接下里咱们就来学习drf并用他来开发restful API。
django rest framework入门.zip
04-03
**Django REST Framework入门教程** Django REST Framework（简称DRF）是一个强大的、灵活的、用于构建Web APIs的工具包，它基于Python和Django框架。这个入门教程将引导你了解如何利用DRF来创建高效且易于理解的...
vswriter.exe
08-29
Windows 8 SDK 此 SDK 于 2012 年 11 月发布，可用于创建适用于 Windows 8 或更早版本的 Windows 应用 () 使用 Web 技术、本机和托管代码;或使用本机或托管编程模型的桌面应用。
wmicodegen.dll
08-29
Windows 8 SDK 此 SDK 于 2012 年 11 月发布，可用于创建适用于 Windows 8 或更早版本的 Windows 应用 () 使用 Web 技术、本机和托管代码;或使用本机或托管编程模型的桌面应用。
C++软件开发校招复习资料总结-西电华为学长分享-资源提取码
08-29
C++软件开发校招复习资料总结-西电华为学长分享-资源提取码
IMG_20240829_221722.jpg
最新发布
08-29
IMG_20240829_221722.jpg
wstracedump.exe
08-29
Windows 8 SDK 此 SDK 于 2012 年 11 月发布，可用于创建适用于 Windows 8 或更早版本的 Windows 应用 () 使用 Web 技术、本机和托管代码;或使用本机或托管编程模型的桌面应用。
基于SpringBoot+Vue3的在线考试系统.zip
08-29
基于SpringBoot+Vue3的在线考试系统
全球与中国电池用胶粘剂市场现状及未来发展趋势（2024版）.docx
08-29
全球与中国电池用胶粘剂市场现状及未来发展趋势（2024版）.docx
Django rest framework后端开发文档
05-21
Django REST framework是一个基于Django的强大Web API框架，可以帮助开发者快速构建RESTful API。下面是Django REST framework后端开发的文档。 ## 安装 可以通过pip安装Django REST framework： ``` pip install djangorestframework ``` ## 配置 1. 将`rest_framework`添加到`INSTALLED_APPS`中： ```python INSTALLED_APPS = [ ... 'rest_framework', ... ] ``` 2. 添加REST framework的默认设置到`settings.py`文件中： ```python REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.AllowAny', ], 'DEFAULT_AUTHENTICATION_CLASSES': [ 'rest_framework.authentication.SessionAuthentication', 'rest_framework.authentication.BasicAuthentication', ], } ``` ## 序列化 Django REST framework的核心是序列化。它允许将复杂的Python数据结构转换为JSON、XML等格式。 ### 创建序列化器 1. 创建一个`serializers.py`文件，并导入`serializers`： ```python from rest_framework import serializers from .models import Book ``` 2. 创建一个`BookSerializer`类： ```python class BookSerializer(serializers.ModelSerializer): class Meta: model = Book fields = '__all__' ``` `fields`属性指定了需要序列化的模型字段。 ### 使用序列化器 在视图中使用序列化器，可以将模型转换为JSON格式的响应。 ```python from rest_framework import generics from .models import Book from .serializers import BookSerializer class BookList(generics.ListCreateAPIView): queryset = Book.objects.all() serializer_class = BookSerializer ``` ## 视图 Django REST framework提供了多种视图，包括基于函数的视图和基于类的视图。 ### 基于函数的视图 1. 创建一个`views.py`文件，并导入Django REST framework的视图： ```python from rest_framework.decorators import api_view from rest_framework.response import Response ``` 2. 创建一个`book_list`函数： ```python @api_view(['GET', 'POST']) def book_list(request): if request.method == 'GET': books = Book.objects.all() serializer = BookSerializer(books, many=True) return Response(serializer.data) elif request.method == 'POST': serializer = BookSerializer(data=request.data) if serializer.is_valid(): serializer.save() return Response(serializer.data, status=201) return Response(serializer.errors, status=400) ``` `@api_view`装饰器表示该视图只接受`GET`和`POST`请求。`BookSerializer`用于将模型转换为JSON格式的响应。 ### 基于类的视图 1. 创建一个`views.py`文件，并导入Django REST framework的视图： ```python from rest_framework import generics ``` 2. 创建一个`BookList`类： ```python class BookList(generics.ListCreateAPIView): queryset = Book.objects.all() serializer_class = BookSerializer ``` `queryset`属性指定需要序列化的模型，`serializer_class`属性指定使用的序列化器。 ## 路由 Django REST framework的路由是基于Django的URLconf的。可以使用Django REST framework自带的`DefaultRouter`或者自定义路由。 ### 使用`DefaultRouter` 1. 创建一个`urls.py`文件，并导入`DefaultRouter`： ```python from rest_framework.routers import DefaultRouter ``` 2. 在`views.py`中导入视图，并创建一个`router`： ```python from .views import BookList router = DefaultRouter() router.register(r'books', BookList) ``` `r'books'`是路由名称，`BookList`是视图类。 3. 在`urls.py`中将路由添加到URLconf中： ```python from django.urls import path, include urlpatterns = [ path('', include(router.urls)), ] ``` ### 自定义路由 1. 创建一个`urls.py`文件，并导入视图： ```python from django.urls import path from .views import book_list ``` 2. 创建一个URLconf： ```python urlpatterns = [ path('books/', book_list, name='book-list'), ] ``` `book_list`是一个基于函数的视图。 3. 在主URLconf中包含自定义路由： ```python from django.urls import path, include urlpatterns = [ path('', include('myapp.urls')), ] ``` ## 认证和权限 Django REST framework提供了多种认证和权限选项，可以通过`settings.py`中的`DEFAULT_AUTHENTICATION_CLASSES`和`DEFAULT_PERMISSION_CLASSES`设置默认选项。 ### 认证 Django REST framework提供了多种认证选项，包括SessionAuthentication、BasicAuthentication和TokenAuthentication等。 ```python REST_FRAMEWORK = { 'DEFAULT_AUTHENTICATION_CLASSES': [ 'rest_framework.authentication.SessionAuthentication', 'rest_framework.authentication.BasicAuthentication', 'rest_framework.authentication.TokenAuthentication', ], } ``` ### 权限 Django REST framework提供了多种权限选项，包括AllowAny、IsAuthenticated和IsAdminUser等。 ```python REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.AllowAny', 'rest_framework.permissions.IsAuthenticated', 'rest_framework.permissions.IsAdminUser', ], } ``` ## 参考资料 - [Django REST framework官方文档](https://www.django-rest-framework.org/) - [Django REST framework教程](https://www.django-rest-framework.org/tutorial/1-serialization/)
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

侯天阔Kirstyn

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值