接口自动化测试平台项目环境搭建

这篇文章主要记录开发接口自动化测试平台的尝试作---环境搭建和写一个项目管理模型。

电脑需要有python环境，且已经安装了django，我用的是python3.12 和 django 最新版本。写代码我使用的pycharm。

其中环境搭建大概分下面几步：

一、在代码存放路径打开终端，输入下面命令新建一个django项目Ifat

django-admin startproject Ifat

二、使用pycharm打开项目Ifat

三、给项目Ifat创建虚拟环境

补充：创建虚拟环境主要是为了减少不同项目环境之间的相互影响，也有利于更加专注于当前项目。

四、在虚拟环境中安装django

五、在项目Ifat中新建一个应用apitest，命令如下

python manage.py startapp apitest

django官方给出了项目和应用的解释，如下

项目 VS 应用
项目和应用有什么区别？
应用是一个专门做某件事的网络应用程序------比如博客系统，或者公共记录的数据库，
或者小型的投票程序。
项目则是一个网站使用的配置和应用的集合。
项目可以包含很多个应用，应用可以被很多个项目使用。

所以这个平台主要的逻辑都在apitest这个应用中实现。

六、将应用apitest安装到项目中，具体配置如下

补充：settings.py文件中主要是项目的一些相关配置，实际工作中用的是mysql数据库，为了方便专注于平台逻辑实现，暂时只用默认的sqlite3数据库，其他配置项可能会根据后面具体实现修改。

七、输入下面命令运行一下项目

python manage.py runserver

访问http://127.0.0.1:8000/，可以跳转到一个django的默认页面，此时和平台相关的内容还都没有，只要正常打开网页即可。

阶段性总结：上述7个步骤就是前期准备工作，后面会将各个模块的具体实现步骤都记录于此。

环境搭好了就开始尝试写一个简单的模块------项目管理模块。

首先了解一下django的MTV开发模式，这基本贯穿整个平台的开发过程。
Model(模型)：负责业务对象与数据库的对象(ORM)，在这部分进行数据库字段的定义
Template(模版)：负责如何将数据渲染到页面并与用户交互
View(视图)：这部分主要实现具体业务逻辑，并与Model和Template交互
此外，Django还有一个urls分发器，它的作用是将一个个URL的页面请求分发给不同的view处理，
view再调用相应的Model和Template

接下来开始拆解要做的项目管理模块，主要是项目的新增、编辑、删除这三块逻辑。根据MTV加url原则可知，需要进行如下四步：

在models中定义数据库字段
在views.py文件写逻辑，也就是具体的接口
新建template模板，写页面
新增urls.py文件，将不同url分发给views处理

(一) 先让项目跑起来

一、在models.py 文件中定义Department 和Project这两个类，用于存放不同部门和不同项目的数据，具体代码如下

# models.py
from django.db import models
# Create your models here.
class Department(models.Model):
#部门名称
name = models.CharField(max_length=100)
# 是否删除
is_delete = models.IntegerField(default=0)
def __str__(self):
return self.name
class Project(models.Model):
# 项目名称
name = models.CharField(max_length=100)
# 部门外键关联到Department模型
department = models.ForeignKey(Department, on_delete=models.CASCADE, default=1)
# 是否删除
is_delete = models.IntegerField(default=0)
def __str__(self):
return self.__class__()
class Meta:
# 按照department字段排序
ordering = ['department']

二、在views.py文件中实现查询、新增项目信息以及保存入库的方法

# views.py
from django.shortcuts import render
# Create your views here.
from apitest.models import Department, Project
def project(request):
username = request.session.get('user', '')
departments = Department.objects.filter(is_delete=0)
department = Department.objects.filter(is_delete=0)[0]
project_list = Project.objects.filter(is_delete=0, department=department)
project = ''
context = {"user": username,
"projects": project_list,
"departments": departments,
"department": department,
"project": project}
# 将数据渲染到project.html，展示给用户
return render(request, 'apitest/project.html', context)
@csrf_exempt
def department_onchange(request):
departmentId = request.POST.get("departmentId", '')
if (departmentId != '请选择部门' and departmentId != ''):
department = Department.objects.get(id=departmentId)
projects = Project.objects.filter(department=department, is_delete=0)
else:
projects = Project.objects.filter(is_delete=0)
context = {'projects': projects}
return render(request, "apitest/onchange_project.html", context)
def add_project(request):
departments = Department.objects.filter(is_delete=0)
context = {'departments': departments}
return render(request, "apitest/add_project.html", context)
@csrf_exempt
def add_project_to_db(request):
projectName = request.POST.get("projectName", '')
departmentId = request.POST.get("department", '')
department = Department.objects.get(id=departmentId)
project = Project.objects.create(name=projectName, department=department)
projectId = project.id
return HttpResponseRedirect('/apitest/project/' + str(departmentId) + '/' + str(projectId) + '/')

三、新建templates目录，并新建apitest二级目录，然后新建base.html、project.html、add_project.html、onchange_project.html文件，可以看到base.html里面引用了一些css、js、图片等文件，所以在static/apitest目录新建这些文件目录，并存放对应文件即可，目录结构如下图，代码太多了就不放了。

四、在应用apitest下新建urls.py文件，将不同url分发给不同的views方法。具体位置如下

到此基本逻辑已经完成，但是启动项目不会达到想要的效果，因为有两个问题没有解决：

项目url和应用url没有关联，导致web页面访问无效
models.py文件只是创建了数据库字段，但是数据库中没有生成，导致访问对应的接口会报错提示找不到表。

解决第一个问题，在项目的urls.py文件中添加一下代码关联应用urls

解决第二个问题，在中端执行如下命令进行数据库迁移

复制代码

python manage.py makemigrations
python manage.py migrate

需要注意的是

每次编辑 models.py 文件，改变模型，都需要执行下面两个命令。
运行 python manage.py makemigrations 为模型的改变生成迁移文件。
运行 python manage.py migrate 来应用数据库迁移。
关于数据库迁移相关的内容可以参考django文档了解更多暂不展开

迁移完成后，使用pycharm的sqlite数据库手动新增几条数据进行初始化，然后保存提交

完成以上四个步骤，这个项目算是能跑起来了，但是项目管理模块的具体功能逻辑还没有完成，接下来就是完善该模块的具体功能。

(二) 完善剩余逻辑

写之前先捋一捋，考虑到公司部门变动不是很频繁，所以直接在数据库表中初始化了部门数据，没有提供部门的增删改逻辑。本文重点是项目管理模块，所以要实现项目的增删改查功能，上面第一部分中已经实现了新增项目的功能，接下来就直接实现删改查功能

一、实现项目列表页面以及项目查询接口逻辑，大概分3步

（1）首先写一个页面用于展示项目信息，命名为project_list.html，代码里删除部分的功能在第四步会实现。

（2）然后在views.py文件中新增查询接口

复制代码

@csrf_exempt
def ajax_require_project(request):
project_list = get_project_list(request)
departments = Department.objects.filter(is_delete=0)
context = {
"projects": project_list,
"departments": departments
}
return render(request, 'apitest/project_list.html', context)

其中get_project_list这个方法提出来放到新建的utils/projectsinfo.py这个文件中，这样看着views.py里面比较舒服。

# -*- encoding: utf-8 -*-
from apitest.models import Project
def get_project_list(request):
projectId = request.POST.get('project', '')
departmentId = request.POST.get('department', '')
if departmentId == '请选择部门' or departmentId == '':
project_list_department = Project.objects.filter(is_delete=0)
else:
project_list_department = Project.objects.filter(department=departmentId, is_delete=0)
if projectId == '请选择项目' or projectId == '':
project_list_project = Project.objects.filter(is_delete=0)
else:
project_list_project = Project.objects.filter(id=projectId)
a = list(set(project_list_department).intersection(set(project_list_project)))
a.sort(key=lambda Project: Project.department.id, reverse=False)
return a

（3）然后在urls.py文件中新增路由

path('ajax_require_project/', views.ajax_require_project, name='ajax_require_project'),

二、实现跳转到指定部门指定项目的接口逻辑，大概2步

（1）在view.py中实现接口

def project_department_project(request, departmentId, projectId):
data = get_department_project(departmentId, projectId)
return render(request, 'apitest/project.html', data)

其中get_department_project方法在utils/projectsinfo.py中实现

def get_department_project(departmentId, projectId):
projects = Project.objects.filter(is_delete=0)
departments = Department.objects.filter(is_delete=0)
project = ''
if departmentId == 0 or departmentId == '0':
departmentId = 1
else:
department = Department.objects.get(id=departmentId)
projects = Project.objects.filter(department=department)
if projectId != 0 and projectId != '0' and projectId != '请选择项目':
project = Project.objects.get(id=projectId)
department = Department.objects.get(id=departmentId)
data = {}
data['departments'] = departments
data['projects'] = projects
data['department'] = department
data['project'] = project
return data

（2）然后在urls.py中新增路由

path('project/<int:departmentId>/<int:projectId>/', views.project_department_project, name='project'),

实现上述功能之后可以看到在新增一个项目点击保存跳转到一个新页面

三、实现编辑项目信息的功能，该功能分两个接口，一个是编辑接口，一个是编辑后保存数据入库接口。大概分3步

（1）首先写一个编辑项目信息的页面，命名为modify_project.html

（2）在views.py中写接口逻辑

@csrf_exempt
def modify_project(request, pid):
project = get_object_or_404(Project, id=pid)
departments = Department.objects.filter(is_delete=0)
context = {'project': project, 'departments': departments}
return render(request, "apitest/modify_project.html", context)
@csrf_exempt
def modify_project_to_db(request, pid):
project = Project.objects.get(id=pid)
projectName = request.POST.get("projectName", '')
departmentId = request.POST.get("department", '')
department = Department.objects.get(id=departmentId)
project.name = projectName
project.department = department
project.save()
return HttpResponseRedirect('/apitest/project/' + str(departmentId) + '/' + '0' + '/')

（3）在urls.py中新增具体路由

path('modify_project/<int:pid>/', views.modify_project),
path('modify_project_to_db/<int:pid>/', views.modify_project_to_db),

四、实现删除项目信息的接口逻辑，大概分2步

（1）在views.py中写接口逻辑

@csrf_exempt
def delete_project_to_db(request, pid):
project = Project.objects.get(id=pid)
project.is_delete = 1
project.save()
data = get_delete_info(request)
return HttpResponseRedirect('/apitest/project/' + str(data["departmentId"]) + '/' + str(data["projectId"]) + '/')

其中get_delete_info方法在utils/projectsinfo.py中实现

def get_delete_info(request):
projectId = request.POST.get('project', '')
departmentId = request.POST.get('department', '')
department_0 = Department.objects.filter(is_delete=0)[0].id
try:
project = Project.objects.get(id=projectId, is_delete=0)
except:
projectId = 0
if departmentId == '' or departmentId == '请选择部门':
departmentId = department_0
data = {}
data["departmentId"] = departmentId
data["projectId"] = projectId
return data

（2）在urls.py中新增路由

path('delete_project/<int:pid>/', views.delete_project_to_db),

到这里，这个平台的项目管理模块的功能基本上就实现完成了，后面的运行环境、接口集合、定时任务、流程测试基本上都是这个套路，写一些增删改查的代码。另外，本文中前端代码都没贴，太多了就不一一展开了。