三十二、实战演练之接口自动化平台的模型创建、项目管理接口设计

已于 2023-03-30 10:35:08 修改
阅读量439 收藏 2
点赞数
分类专栏： Django 文章标签： django python 后端
于 2023-03-20 21:37:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sean_0819/article/details/129641183
版权
文章详细描述了使用Django框架构建项目管理应用的过程，包括项目、测试计划、测试报告和bug管理的应用模型设计，以及相关的接口设计。模型涵盖了项目信息、测试环境、接口、bug状态等关键数据结构。此外，还介绍了项目创建、删除、修改等接口的API设计。
摘要由CSDN通过智能技术生成

1. 模型编写

根据项目需求分析和数据库设计，我们创建项目应用，测试计划应用，测试报告应用，bug应用：

django-admin startapp projects
django-admin startapp testplans
django-admin startapp reports
django-admin startapp bugs

注意在配置文件中注册应用。然后分别创建对应的模型如下：

（1）项目应用模型

from django.db import models
from utils.models import BaseModel


class Project(models.Model):
    """项目表"""
    name = models.CharField(max_length=50, help_text='项目名称', verbose_name='项目名')
    leader = models.CharField(max_length=50, help_text='负责人', verbose_name='负责人', default='')
    create_time = models.DateTimeField(verbose_name='创建时间', help_text='创建时间', auto_now_add=True)

    def __str__(self):
        return self.name

    class Meta:
        db_table = 'project'
        verbose_name = "项目表"
        verbose_name_plural = verbose_name


class TestEnv(models.Model):
    """测试环境表"""
    name = models.CharField(max_length=150, help_text='环境名称', verbose_name='环境名称')
    # 一个项目有多个测试环境，一个环境只属于一个项目
    # models.CASCADE 删除项目的时候，就把相关环境同步删除。
    project = models.ForeignKey(Project, on_delete=models.CASCADE, help_text='项目id', verbose_name='项目id',
                                related_name='test_envs')  # 反向字段名
    global_variable = models.JSONField(help_text='全局变量', verbose_name='全局变量', default=dict, null=True,
                                       blank=True)
    debug_global_variable = models.JSONField(help_text='debug模式全局变量', verbose_name='debug模式全局变量',
                                             default=dict, null=True, blank=True)
    db = models.JSONField(help_text='数据库配置', verbose_name='数据库配置', default=list, null=True, blank=True)
    host = models.CharField(help_text='base_url地址', verbose_name='base_url地址', max_length=100, blank=True)
    headers = models.JSONField(help_text='请求头', verbose_name='请求头', default=dict, null=True, blank=True)
    global_func = models.TextField(help_text='用例工具文件', verbose_name='用例工具文件',
                                   default=open('utils/global_func.py', 'r', encoding='utf-8').read(), null=True,
                                   blank=True)

    def __str__(self):
        return self.name

    class Meta:
        db_table = 'tb_test_env'
        verbose_name = "测试环境表"
        verbose_name_plural = verbose_name


class Interface(models.Model):
    """接口表"""
    CHOICES = [
        ('1', '项目接口'),
        ('2', '外部接口')
    ]
    project = models.ForeignKey(Project, on_delete=models.CASCADE, help_text='项目id',
                                verbose_name='项目id',
                                related_name='interfaces')
    name = models.CharField(max_length=50, help_text='接口名称', verbose_name='接口名')
    url = models.CharField(max_length=200, help_text='接口路径', verbose_name='接口路径')
    method = models.CharField(max_length=50, help_text='请求方法', verbose_name='请求方法')
    type = models.CharField(verbose_name='接口类型', help_text='接口类型',
                            max_length=40, choices=CHOICES, default='1')

    def __str__(self):
        return self.url

    class Meta:
        db_table = 'tb_interface'
        verbose_name = '接口表'
        verbose_name_plural = verbose_name

（2）bug应用模型

from django.db import models


class Bug(models.Model):
    """Bug模型"""
    CHOICES = [
        ('未处理', '未处理'),
        ('处理中', '处理中'),
        ('处理完', '处理完'),
        ('无效bug', '无效bug'),
    ]
    # 项目
    project = models.ForeignKey('projects.Project', on_delete=models.CASCADE, help_text='项目id', verbose_name='项目id')
    # 接口
    interface = models.ForeignKey('projects.Interface', on_delete=models.CASCADE, verbose_name='接口', help_text='接口')
    # bug描述
    desc = models.TextField(verbose_name='bug描述', help_text='bug描述', max_length=3000, blank=True)
    # bug基本信息 （请求头 请求体 请求方式 响应结果）
    info = models.JSONField(verbose_name='bug信息', help_text='bug信息', default=dict, blank=True)
    # bug状态 （待提交，已提交，处理中，关闭，无效bug）
    status = models.CharField(verbose_name='bug状态', help_text='bug状态', max_length=40, choices=CHOICES,
                              default='未处理')
    # bug提交者
    user = models.CharField(verbose_name='提交者', help_text='提交者', max_length=40, default='', blank=True)
    create_time = models.DateTimeField(verbose_name='创建时间', help_text='创建时间', auto_now_add=True)

    class Meta:
        db_table = 'tb_bug'
        verbose_name = 'bug表'
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.id


class BugHandle(models.Model):
    """bug操作记录表"""
    bug = models.ForeignKey('Bug', on_delete=models.CASCADE, verbose_name='bug_id', help_text='bug_id')
    create_time = models.DateTimeField(verbose_name='创建时间', help_text='创建时间', auto_now_add=True)
    handle = models.TextField(verbose_name='处理操作', help_text='处理操作', blank=True)
    update_user = models.CharField(verbose_name='更新用户', help_text='更新用户', max_length=32, blank=True)

    class Meta:
        db_table = 'tb_bug_handle'
        verbose_name = 'bug操作记录表'
        verbose_name_plural = verbose_name

（3）测试报告应用模型

from django.db import models


class Record(models.Model):
    """运行记录表"""
    create_time = models.DateTimeField(verbose_name='创建时间', help_text='创建时间', auto_now_add=True)
    plan = models.ForeignKey('testplans.TestPlan', help_text='执行计划', verbose_name='执行计划',
                             on_delete=models.PROTECT, related_name='records')
    all = models.IntegerField(help_text='用例总数', verbose_name='用例总数', blank=True, default=0)
    success = models.IntegerField(help_text='成功用例', verbose_name='成功用例', blank=True, default=0)
    fail = models.IntegerField(help_text='失败用例', verbose_name='失败用例', blank=True, default=0)
    error = models.IntegerField(help_text='错误用例', verbose_name='错误用例', blank=True, default=0)
    pass_rate = models.CharField(help_text='执行通过率', verbose_name='执行通过率', max_length=100, blank=True,
                                 default=0)
    tester = models.CharField(help_text='执行者', verbose_name='执行者', max_length=100, blank=True)
    test_env = models.ForeignKey('projects.TestEnv', help_text='测试环境', verbose_name='测试环境',
                                 on_delete=models.PROTECT)
    statue = models.CharField(help_text='执行状态', verbose_name='执行状态', max_length=100)

    def __str__(self):
        return str(self.id)

    class Meta:
        db_table = 'tb_record'
        verbose_name = '运行记录表'
        verbose_name_plural = verbose_name


class Report(models.Model):
    """测试报告"""
    info = models.JSONField(help_text='测试报告', verbose_name='测试报告', default=dict, blank=True)
    record = models.OneToOneField('Record', help_text='测试记录', verbose_name='测试记录 ', on_delete=models.PROTECT)

    def __str__(self):
        return str(self.id)

    class Meta:
        db_table = 'tb_report'
        verbose_name = '报告表'
        verbose_name_plural = verbose_name

（4）测试计划应用模型

from django.db import models


class TestPlan(models.Model):
    """测试计划"""
    create_time = models.DateTimeField(verbose_name='创建时间', help_text='创建时间', auto_now_add=True)
    name = models.CharField(verbose_name='计划名', help_text='计划名', max_length=150)
    project = models.ForeignKey('projects.Project', verbose_name='项目id', help_text='项目id', on_delete=models.CASCADE,
                                related_name='test_plan')
    scenes = models.ManyToManyField('TestScene', help_text='包含的测试场景', verbose_name='包含的测试场景', blank=True)

    def __str__(self):
        return self.name

    class Meta:
        db_table = 'tb_test_plan'
        verbose_name = '测试计划表'
        verbose_name_plural = verbose_name


class TestScene(models.Model):
    """测试场景/测试套件"""
    # 一系列有顺序的测试用例
    project = models.ForeignKey('projects.Project', help_text='所属项目', verbose_name='项目名称',
                                on_delete=models.PROTECT, related_name='test_scenes')
    name = models.CharField(max_length=50, help_text='测试场景名', verbose_name='测试场景名')

    def __str__(self):
        return self.name

    class Meta:
        db_table = 'tb_test_scene'
        verbose_name = "测试场景"
        verbose_name_plural = verbose_name


class SceneData(models.Model):
    """场景/套件数据"""
    step = models.ForeignKey('TestStep', help_text='步骤', verbose_name='步骤',
                             on_delete=models.PROTECT)
    scene = models.ForeignKey(TestScene, help_text='场景', verbose_name='场景', on_delete=models.PROTECT)
    sort = models.IntegerField(help_text='执行顺序', verbose_name='执行顺序',
                               blank=True)

    def __str__(self):
        return str(self.id)

    class Meta:
        db_table = 'tb_scene_data'
        verbose_name = "场景步骤"
        verbose_name_plural = verbose_name


setup_script = """
# 前置脚本(python):
# global_tools:全局工具函数
# data:用例数据
# env: 局部环境

# ENV: 全局环境
# db: 数据库操作对象
"""
teardown_script = """
# 后置脚本(python):
# global_tools:全局工具函数
# data:用例数据
# response:响应对象response
# env: 局部环境
# ENV: 全局环境
# db: 数据库操作对象
"""


class TestStep(models.Model):
    """用例表"""
    title = models.CharField(max_length=50, help_text='用例名称', verbose_name='用例名')
    interface = models.ForeignKey('projects.Interface', on_delete=models.CASCADE, help_text='接口', verbose_name='接口')
    headers = models.JSONField(help_text='请求头', verbose_name='请求头', default=dict, blank=True)
    request = models.JSONField(help_text='请求信息', verbose_name='请求信息', default=dict, blank=True)
    file = models.JSONField(help_text='上传的文件参数', verbose_name='上传的文件', default=list, blank=True)
    setup_script = models.TextField(help_text='前置脚本', verbose_name='前置脚本', default=setup_script, blank=True)
    teardown_script = models.TextField(help_text='后置脚本', verbose_name='用例后置脚本 ', default=teardown_script,
                                       blank=True)

    def __str__(self):
        return self.title

    class Meta:
        db_table = 'tb_test_step'
        verbose_name = "测试步骤表"
        verbose_name_plural = verbose_name

二、项目管理接口设计

（1）项目创建

接口名称： /projects/

请求方式： POST

参数格式： JSON

请求参数：

参数

变量名

类型

说明

是否必传

项目名称

name

字符串

项目名称

是

项目负责人

leader

字符串

项目负责人

是

请求示例：

json格式参数

{

"name": "前程贷",

"leader": "心蓝"

}

返回示例

响应状态码：201 响应数据：

{

"id": 1,

"create_time": "2022-07-12T21:59:57.606147+08:00",

"name": "ck12接口自动化",

"leader": "心蓝"

}

（2）删除项目

接口名称： /projects/项目ID/

请求方式： DELETE

参数格式： 路径参数

请求参数：无

返回示例

响应状态码：204

响应数据：无

（3）修改项目

接口名称： /projects/项目ID/

请求方式： PUT/PATCH

参数格式： JSON

请求参数：

参数

变量名

类型

说明

是否必传

项目名称

name

字符串

项目名称

PUT请求必传

项目负责人

leader

字符串

项目负责人

PUT请求必传

请求示例：

json格式参数

{

"name": "前程贷",

"leader": "心蓝"

}

返回示例

响应状态码：200 响应数据：

{

"id": 1,

"create_time": "2022-07-12T21:59:57.606147+08:00",

"name": "ck12接口自动化",

"leader": "心蓝"

}

（4）查看项目列表

接口名称：

请求方式： GET

参数格式： 无

请求参数： 无

返回示例

响应状态码：200 响应数据：

[{

id": 1,

"create_time": "2022-07-12T21:59:57.606147+08:00",

"name": "ck12接口自动化",

"leader": "心蓝"

}]

（5）查看项目

接口名称：

请求方式： GET

参数格式： 路径参数

请求参数： 无

返回示例

响应状态码：200 响应数据：

{
  "id": 1,
  "create_time": "2022-07-12T21:59:57.606147+08:00",
  "name": "ck12接口自动化",
  "leader": "心蓝",
  "info": [
    {
      "name": "执行环境",
      "value": 0
    },
    {
      "name": "测试场景",
      "value": 0 	},
    {
      "name": "测试计划",
      "value": 0 	},
    {
      "name": "接口数量",
      "value": 0 	},
    {
      "name": "定时任务",
      "value":0
    },
    {
      "name": "执行记录",
      "value": 0
    }],
  "bugs":[
    {
      "name": "未处理bug",
      "value": 0
    },
    {
      "name": "处理中bug",
      "value": 0
    },
    {
      "name": "处理完bug",
      "value": 0
    },
    {
      "name": "无效bug",
      "value": 0
    }
  ]

（6）后端代码

① 新增模型方法

因为在获取项目详情时需要统计对应的数据，所以我们再项目模型中新增如下方法：

class Project(models.Model):
    """项目表"""
    name = models.CharField(verbose_name="项目名", help_text="项目名称", max_length=50)
    leader = models.CharField(verbose_name="负责人", help_text="项目负责人", max_length=50, default='')
    create_time = models.DateTimeField(verbose_name="创建时间", help_text="", auto_now_add=True)

    def __str__(self):
        return self.name

    class Meta:
        db_table = "project"
        verbose_name = "项目表"
        verbose_name_plural = verbose_name

    def info(self):
        """返回项目的统计信息"""
        return [
            {'name': '执行环境', 'value': self.test_envs.count()},
            {'name': '测试场景', 'value': self.test_scenes.count()},
            {'name': '测试计划', 'value': self.test_plan.count()},
            {'name': '接口数量', 'value': self.interfaces.count()},
            {'name': '定时任务', 'value': 0},
            {'name': '执行记录', 'value': Record.objects.filter(plan__name=self.name).count()},
        ]

    def bugs(self):
        """返回bugs的统计信息"""
        return [
            {'name': '未处理', 'value': self.bug_set.filter(status='未处理').count()},
            {'name': '处理中', 'value': self.bug_set.filter(status='处理中').count()},
            {'name': '处理完', 'value': self.bug_set.filter(status='处理完').count()},
            {'name': '无效bug', 'value': self.bug_set.filter(status='无效bug').count()},
        ]

② 序列化器

在projects应用中创建serializers.py 模块，编写代码如下：

class ProjectSerializer(serializers.ModelSerializer):
    """项目序列化器"""

    # 注意info和bugs是对象方法
    class Meta:
        model = Project
        fields = ['id', 'create_time', 'name', 'leader', 'info', 'bugs']

③ 视图

class ProjectViewSet(ModelViewSet):
    """项目视图集"""
    serializer_class = ProjectSerializer
    queryset = Project.objects.all()
    permission_classes = [IsAuthenticated, IsLeaderOrReadOnly]
    
    # 还可以过滤一下查询集，实现特定的人群看到特定的项目
    def get_queryset(self):
        return Project.objects.filter(leader=self.request.user)

④ 路由

from rest_framework.routers import DefaultRouter

from . import views

router = DefaultRouter()
router.register('projects', views.ProjectViewSet)
urlpatterns = router.urls

覆水难收呀
关注
专栏目录
AI系统API管理原理与代码实战案例讲解
AI天才研究院
07-08 753
AI系统API管理原理与代码实战案例讲解 作者：禅与计算机程序设计艺术 / Zen and the Art of Computer Programming / TextGenWebUILLM AI系统API管理原理与代码实战案例讲解
Bentley AECOsim软件二次开发：AECOsim二次开发案例分析与实战演练
最新发布
kkchenjj的博客
08-17 688
Bentley Systems是一家全球领先的基础设施工程软件公司，其开发平台为工程师、建筑师和施工专业人员提供了强大的工具集，用于设计、模拟和分析各种基础设施项目。Bentley的开发平台包括一系列API（应用程序编程接口），这些API允许开发者扩展和定制Bentley软件的功能，以满足特定项目需求。AECOsim Building Designer是Bentley平台中的一款软件，专门用于建筑信息模型（BIM）的创建和管理，其二次开发能力使得用户能够创建自定义工具和插件，增强软件的灵活性和效率。
接口开发工程
CNMNMSL1的博客
04-07 396
Makefile 1、通用的Makefile，支持SD卡启动和在uboot下直接运行在RAM 区别： 1）程序运行时的地址不同 DDR：0x2000 0000 SD：0x0基地址，最多16K（将SD卡的地址放到iram中运行） 2）SD 只能最多先运行16K并且需要加一个头信息进行校验 RAM ：不需要加头信息 2、一般Makefile 写法是 目标文件：依赖文件 命令 makefile文件编译顺...
NCC、NC6系列接口定制化模型模式下开发
习惯沉默的博客
09-29 1460
适用于NCC系列、NC6系列产品下使用。在多样性、接口数量众多的背景下进行开发接口，能够快速、统一、有效的助力开发接口及后期接口维护与改造
如何基于大模型开发应用接口
2401_85343303的博客
07-12 1101
针对自然语言处理方向，以前要开发一个情感分析、命名实体识别之列的应用是非常麻烦的，我们需要完成收集数据、清理数据、构建模型、训练模型、调优模型等一系列操作，每一步都非常耗时。如今大语言模型（LLM）的出现，极大简化了其中一些任务。LLM像一个全能的自然语言机器，通过一些简单调整，就可以实现一些特定任务。这些特定任务不只限于自然语言的基本任务，我们还可以实现更复杂的应用。今天我们就来详细讨论一下。
商城后台系统商品模型（类型）新增接口开发
呀哈的博客
12-13 560
商品模型新增 接口文档 请求地址 POST /types 需进行token认证 示例：http://adminapi.tbyue.com/types 请求参数 名称 类型 必填 备注 type_name string 是 模型名 spec int 是 规格数组 attr int 是 属性数组 参数示例： type_name: 手机 spec[0][name]: 颜色 spec[0][sort]: 50.
【鸿蒙】大模型对话应用（一）：大模型接口对接与调试
weixin_44348327的博客
01-27 2898
本demo对接阿里云和百度的大模型API，实现一个简单的对话应用。HarmonyOS API版本：API9ArkTS、ArkUI、UIAbility、网络http请求、列表布局。
【实战演练】python开发任务管理系统
[【实战演练】python开发任务管理系统](https://atlas-rc.pingcode.com/files/public/632050072ce1c1a732e11703) # 2.1 数据库设计和数据模型 任务管理系统的核心是数据库设计和数据模型，它决定了系统的数据存储和...
ZigBee入门与实战演练
05-30
### ZigBee入门与实战演练知识点详述 #### 一、ZigBee技术概览 **1.1 无线网络数据传输协议对比** 在无线网络数据传输领域，多种协议并存，各具特色，包括WIFI（IEEE 802.11）、Wireless USB、Bluetooth（蓝牙）...
【实战演练】人脸识别项目：基于LBPH算法
[【实战演练】人脸识别项目：基于LBPH算法](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/36ae584841084d39ab62f5afd5a681ce~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp) # 2.1 LBPH算法的基本原理...
《如何了解软件的设计》学习笔记0——模型-接口-实现
huibin.yun的博客
03-10 1799
程序设计语言接口 程序设计语言的接口不只包含语法，还有程序库。 学习一种程序设计语言提供的模型时，不仅仅要看语法本身有什么，还要了解有语言特性的一些程序库。 Andrew Koenig 和 Barbara Moo 写过一本书《C++ 沉思录》，有两章的标题分别是“语言设计就是程序库设计 ”和“程序库设计就是语言设计 ”。 ...
大模型接口管理和分发系统One API
wbsu2004的博客
04-22 7213
One-API 支持通过标准的 OpenAI API 格式访问所有的大模型，开箱即用。
Django实现接口自动化平台（七）数据库设计
喵酱
06-11 2726
Django实现接口自动化平台（七）数据库设计
AI大模型【基础 01】智能AI开源模型与大模型接口整理（8个开源模型+7个大模型接口）
Java与大数据相关实践内容分享！
01-22 5508
智能AI开源模型与大模型接口整理 2024-01-18
django orm 基本操作
weixin_48448534的博客
03-31 248
values_list: <QuerySet [(3, '张学友', '祝福', '祝福', '1997年1月', '流行', '张学友', '张学友'), (4, '张学友sssssS', '祝福', '祝福', '1997年1月', None, '', '张学友'), (5, '张学友', '忘不了', '忘不了。两个线程同时获取一个Comment对象，第一个线程对它的up字段值加1并保存，这不会有问题。用于操作数据库中某一列的值，它可以在没有实际访问数据库获取数据值的情况下对字段的值进行应用。
datawhale开源项目：动手学大模型应用开发第二三次打卡调用大模型API大模型开发流程及架构
soulermax的博客
11-20 2172
Prompt 最初是 NLP（自然语言处理）研究者为下游任务设计出来的一种任务专属的输入模板，类似于一种任务（例如：分类，聚类等）会对应一种 Prompt。在 ChatGPT 推出并获得大量应用之后，Prompt 开始被推广为给大模型的所有输入。即，我们每一次访问大模型的输入为一个 Prompt，而大模型给我们的返回结果则被称为 Completion。例如，在下面示例中，我们给 ChatGPT 的提问 “NLP 中的 Prompt 指什么”是我们的提问，其实也就是我们此次的 Prompt；
Django模型元数据Meta选项详解
surge
04-06 783
classMeta: verbose_name='文章' verbose_name_plural=verbose_name 一些常见的元信息的例子： classMeta: #数据库中生成的表名称默认app名称+下划线+类名 db_table="table_name" ...
python中open函数打开.py文件,编码错误
yangwenwu11514的博客
12-23 2298
问题： python中open函数打开.py文件，会报错 &gt;&gt;&gt; file=open('example.py','r') &gt;&gt;&gt; for line in file:print(line) ... Traceback (most recent call last): File "&lt;stdin&gt;", line 1, in &lt;module&g...
项目管理实战演练：从启动到收尾的关键步骤
这份189页的PPT课程详细介绍了项目管理的实战演练，旨在帮助学员熟悉项目管理的核心概念和术语，掌握实用的管理方法与工具。课程分为六个部分，涵盖了项目管理的全过程，从项目的启动到收尾，每部分都配以案例练习，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值