迁移django3配置新应用

简介: 【6月更文挑战第4天】本文介绍创建应用的具体步骤。首先创建名为`posts`的新Django应用,实现blog API功能。并说明如何编写测试用例,并执行迁移。建议为API版本控制,如v1和v2,以便逐步升级。

简介

在django3中应用创建一般步骤如下:

1 创建应用
2 配置和注册在settings.INSTALLED_APPS和全局路由注册posts

3 定义Post模型(含5个字段)并注册到admin。
4 配置路由posts/urls.py,用PostListPostDetail视图处理CRUD操作。
5 使用Django REST Framework的PostSerializer排除updated_at字段。

1 创建新应用,扩展api功能

新建posts 应用

        python manage.py startapp posts
  • 在全局setting注册

    INSTALLED_APPS = ['posts.apps.PostsConfig', # blog api]
    
  • 在全局路由 注册 posts路由

    urlpatterns = [path('api/v1/', include('posts.urls')), # new]
    
  • App配置, 模型 models.py, 5个字段

      # posts/models.py
      from django.db import models
      from django.contrib.auth.models import User
      class Post(models.Model):
          author = models.ForeignKey(User, on_delete=models.CASCADE)
          title = models.CharField(max_length=50)
          body = models.TextField()
          created_at = models.DateTimeField(auto_now_add=True)
          updated_at = models.DateTimeField(auto_now=True)
          def __str__(self):
              return self.title
    
  • App配置,在默认管理app中注册

      from .models import Post
      # Register your models here.
    
      admin.site.register(Post)
    

2 PostsApp 路由配置

在app的 urls中,用户访问全局urls后,将被导向这里

      # posts/urls.py
      from django.urls import path
      from .views import PostList, PostDetail

      urlpatterns = [
          path('<int:pk>/', PostDetail.as_view()),
          path('', PostList.as_view()),
      ]

3 PostsApp 序列化操作

接口返回数据 Json 字段

序列化程序不仅可以将数据转换为JSON,还可以指定要包含或包含哪些字段,但是我们不想包含updated_at字段。

Django_REST_Framework强大的序列化程序类使控制变得非常简单。我们创建了一个PostSerializer,并在其中指定了一个Meta类包括哪些字段并明确设置要使用的模型。

有很多方法可以自定义序列化程序.

      # posts/serializers.py
      from rest_framework import serializers
      from .models import Post
      class PostSerializer(serializers.ModelSerializer):
          class Meta:
              fields = ('id', 'author', 'title', 'body', 'created_at',)
              model = Post

4 PostsApp 视图配置

Views.py将 数据转发到 序列化模块

ListCreateAPIView,它类似于我们之前使用的ListAPIView,但允许写。

我们还希望使各个博客文章可供阅读,更新或删除。

确实,为此提供了一个内置的通用Django_REST_Framework视图用途:

             RetrieveUpdateDestroyAPIView。

我们要做的就是更新我们的通用视图以从根本上改变给定API端点的行为。

所有这些功能都是可用的,经过测试的并且可以正常使用。不必在这里重新发明轮子。

此时api通过views视图的更改已经具有 CRUD功能。

      # posts/views.py
      from rest_framework import generics
      from .models import Post
      from .serializers import PostSerializer
  • 可读写的视图

      class PostList(generics.ListCreateAPIView):  
          queryset = Post.objects.all()
          serializer_class = PostSerializer
    
  • 可更新,删除的视图

      class PostDetail(generics.RetrieveUpdateDestroyAPIView):
          queryset = Post.objects.all()
          serializer\_class = PostSerializer
    

5 构建测试模块

我们访问测试客户端并发出GET请求。这模拟了您将使用浏览器发出的请求。注意网络服务器无需运行即可进行单元测试。这测试客户端直接与Django框架一起使用的.

    # posts/tests.py
    from django.test import TestCase
    from django.contrib.auth.models import User
    from .models import Post

    class BlogTests(TestCase):
        @classmethod
        def setUpTestData(cls):
            # Create a user
            testuser1 = User.objects.create_user(
                username='testuser1', password='abc123')
            testuser1.save()
            # Create a blog post
            test_post = Post.objects.create(
                author=testuser1, title='Blog title', body='Body content...')
            test_post.save()

        def test_blog_content(self):
            post = Post.objects.get(id=1)
            author = f'{post.author}'
            title = f'{post.title}'
            body = f'{post.body}'
            self.assertEqual(author, 'testuser1')
            self.assertEqual(title, 'Blog title')
            self.assertEqual(body, 'Body content...')

6 迁移并重启服务

     python manage.py makemigrations posts &&  python manage.py migrate && python manage.py runserver 0.0.0.0:2000

始终对API(v1/,v2/等)进行版本控制,因为更改API的各个使用者也可能需要一些时间才能更新。

那您可以在一段时间内支持API v1的方式,同时还启动新的,更新的v2并避免破坏依赖您API后端的其他应用。

7 小结

在django3中,一个项目中可以有多个应用,创建专用的api应用可能更有意义将所有其他API网址路由都包含进去。

但是对于像这样的基础项目,我宁愿避免仅用于路由的api应用。而是在我们需要时,我们随时可以添加一个。

目录
相关文章
|
3月前
|
前端开发 JavaScript UED
探索Python Django中的WebSocket集成:为前后端分离应用添加实时通信功能
通过在Django项目中集成Channels和WebSocket,我们能够为前后端分离的应用添加实时通信功能,实现诸如在线聊天、实时数据更新等交互式场景。这不仅增强了应用的功能性,也提升了用户体验。随着实时Web应用的日益普及,掌握Django Channels和WebSocket的集成将为开发者开启新的可能性,推动Web应用的发展迈向更高层次的实时性和交互性。
111 1
|
3月前
|
IDE 关系型数据库 MySQL
Django学习一:创建Django框架,介绍Django的项目结构和开发逻辑。创建应用,编写主包和应用中的helloworld
这篇文章是关于如何创建一个Django框架,介绍Django的项目结构和开发逻辑,并指导如何创建应用和编写“Hello, World!”程序的教程。
180 3
Django学习一:创建Django框架,介绍Django的项目结构和开发逻辑。创建应用,编写主包和应用中的helloworld
|
3月前
|
关系型数据库 MySQL Java
Django学习二:配置mysql,创建model实例,自动创建数据库表,对mysql数据库表已经创建好的进行直接操作和实验。
这篇文章是关于如何使用Django框架配置MySQL数据库,创建模型实例,并自动或手动创建数据库表,以及对这些表进行操作的详细教程。
117 0
Django学习二:配置mysql,创建model实例,自动创建数据库表,对mysql数据库表已经创建好的进行直接操作和实验。
|
3月前
|
监控 应用服务中间件 网络安全
部署Django应用:使用Gunicorn和Nginx构建高效的生产环境
部署Django应用:使用Gunicorn和Nginx构建高效的生产环境
196 0
|
3月前
|
存储 开发框架 JSON
【查漏补缺】Django模型字段类型及其应用
【查漏补缺】Django模型字段类型及其应用
32 0
|
3月前
|
存储 安全 UED
GitHub OAuth认证的Django应用
GitHub OAuth认证的Django应用
35 0
|
5月前
|
中间件 数据库连接 UED
Django中间件秘籍:如何用几行代码让你的应用变得超级强大?
【8月更文挑战第31天】中间件是Django框架的核心特性,位于视图与HTTP服务器之间,允许全局处理请求和响应,增强Web应用功能。通过实现`MiddlewareMixin`类的方法,如`process_request`和`process_response`,可以轻松实现请求预处理或响应后处理。中间件应用场景广泛,包括用户认证、CSRF防护和数据库连接管理等。创建并配置中间件需将其加入`settings.py`的`MIDDLEWARE`列表,顺序决定执行优先级。合理利用中间件能提高代码重用性和应用性能,带来更好的用户体验。
61 0
|
5月前
|
关系型数据库 MySQL 机器人
Django入门到放弃之数据库配置
Django入门到放弃之数据库配置
|
5月前
|
前端开发 JavaScript 安全
Django入门到放弃之常见配置及基本命令
Django入门到放弃之常见配置及基本命令
|
6月前
|
API 数据库 数据安全/隐私保护
Django配置api、管理系统和视图
Django配置api、管理系统和视图
136 1

热门文章

最新文章

下一篇
开通oss服务