迁移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应用。而是在我们需要时,我们随时可以添加一个。

目录
相关文章
|
15天前
|
API 数据安全/隐私保护 网络架构
在django3中配置应用的权限
【6月更文挑战第9天】该文档介绍了Django REST Framework的权限管理。总结来说,本文介绍如何设置严格项目权限和如何通过自定义权限控制对特定资源的访问。
29 10
在django3中配置应用的权限
|
16天前
|
存储 JSON API
在django3应用中使用现代的JWT鉴权
【6月更文挑战第8天】本文介绍流行的鉴权方式,JSON Web Tokens (JWT) 是一种验证JSON数据所有者的机制,它是一个编码的、安全的字符串,包含可信任的数据且能加密签名。无状态的令牌认证允许客户端存储令牌并将其在每次请求。
26 8
在django3应用中使用现代的JWT鉴权
|
17天前
|
存储 安全 API
在django中创建项目时应用基础鉴权
【6月更文挑战第7天】本文探讨了在django中的API权限管理,即用户认证的两种方法:基础认证和会话认证。Django REST Framework默认使用会话认证,但也提供基础、令牌和JWT等其他选项。根据项目需求,应谨慎选择适合的认证方案。
63 3
在django中创建项目时应用基础鉴权
|
20天前
|
前端开发 JavaScript Linux
分离前后端react和django3构建的应用
【6月更文挑战第4天】在本文中,我们介绍了如何设置React前端并连接到Django后端。并讨论了前后端分离的好处,并计划扩展API以支持更多HTTP操作和用户身份验证功能。
53 5
分离前后端react和django3构建的应用
|
18天前
|
安全 API 数据安全/隐私保护
在django应用中使用权限控制
【6月更文挑战第6天】本文介绍在Django REST Framework中,项目权限通过默认设置如AllowAny、IsAuthenticated等管理。通过定制权限策略,确保了API的安全访问。
74 1
在django应用中使用权限控制
|
9天前
|
存储 流计算 Python
使用Django构建即时通讯应用的最简单方法
使用Django构建即时通讯应用的最简单方法
|
12天前
|
存储 安全 数据库
在django应用中使用会话提示用户体验
【6月更文挑战第12天】该文档介绍了Django中如何利用会话(session)为用户提供定制体验。通过会话,开发者能更好地管理和个性化匿名用户的网站体验。参考[Django官方文档](https://docs.djangoproject.com/en/4.0/top
20 2
|
14天前
|
API 数据库 网络架构
在django中应用视图和路由集
【6月更文挑战第10天】 本文介绍viewsets`和`Routers`是Django REST framework中用于简化API视图和路由的工具。它们提供了一个抽象层,允许用更少的代码替代多个相关视图,并能自动生成URL。定义`UserList`和`UserDetail`视图集,分别用于列表和详情展示。
14 3
|
19天前
|
安全 API 数据安全/隐私保护
在django3查看项目和编辑应用权限
【6月更文挑战第5天】本文介绍在Django REST Framework中,权限管理对于Web API的安全至关重要。总的来说,应实施严格的项目级别权限,并按需调整视图级别的权限策略,利用DRF的内置权限系统增强安全性。
33 2
|
22天前
|
API Python JSON
使用django创建简单restful应用接口的步骤
【6月更文挑战第2天】本文简介使用Django创建API服务涉及安装djangorestframework,创建api应用,定义URL路由,编写视图和序列化器。这个过程展示了如何用Django Rest Framework构建JSON格式的API。
25 2