csdn最牛最全Flask 编写http接口api及接口自动化测试_flask做http api接口(1)

先自我介绍一下，小编浙江大学毕业，去过华为、字节跳动等大厂，目前阿里P7

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年最新软件测试全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上软件测试知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以添加V获取：vip1024b （备注软件测试）

正文

“tel”:“+86-029-88880000”,
“phone”: “13800138000”,
“org_id”: “7d22d25a-b648-4ad3-a834-2398eb989a9e”,
“org_array”:None,
“comments”: “备注信息”
}
}

使用requests的post方法进行请求路由

_resp = requests.post(self.guardian_base + ‘/guardian/users’, json=user, headers=myheaders, verify=True)
resp_json = _resp.content

对返回结果及状态进行校验

if _resp.ok:
self.assertIsNotNone(resp_json)
LOG.info(‘create users, response: {0}’.format(resp_json))
else:
LOG.error(‘error create users, response: {0}, status: {1}’.format(resp_json, _resp.status_code))

接口：修改用户

点我全套软件测试(自动化测试)学习资料抱走【备注csdn000】学习资料抱走【备注csdn000】")

修改用户和新增用户传递的参数差不多，使用的是http的patch请求，route要添加user_id的参数 ，其他实现和新增差不多代码不重复贴了

@app.route(‘/guardian/users/string:user_id’, methods=[‘PATCH’])
@require_role(‘guardian_admin’)
@login_required
def update_user(user_id):
“”"
此处省略接收请求数据代码
“”"
try:
resp = usermgt.update_user(domain_id, user_id, username, user_passwd, project_id, enabled) # 更新keystone 用户密码、状态
if resp is not None:

更新用户基本信息与新增是同一个接口，执行SQL时使用PostGresql特性，相同user_id数据只更新不会再插入

GuardianModelDao._save_update_users_info(user_id, username, real_name, email, tel, phone, org_id, org_array, comments)
return wrap_response(SUCCESS_MSG, 200) # 更新成功返回 200
except Exception as e:
LOG.exception(‘error modify user’, e)
abort(500) # 更新失败500

测试脚本(修改用户)

def test_update_user_api(self):

myheaders = {‘Content-Type’: ‘application/json’}
myheaders[‘X-Subject-Token’] = self.user_token

user = {
“user”: {
“domain_id”: “default”,
“enabled”: True,
“name”: “tsbc1”,
“password”: “111111”,
“realname”: “xioohua”,
“email”: “haoydun@123.com”,
“tel”: “+86-029-88880000”,
“phone”: “13800138000”,
“org_id”: “7d22d25a-b648-4ad3-a834-2398eb989a9e”,
“comments”: “备注信息”
}
}

_resp = requests.patch(self.guardian_base + ‘/guardian/users/0d26176579e94d558c4c2d864b003241’, # 路由中添加要修改的用户ID requests使用 patch方法
json=user, headers=myheaders, verify=True)
resp_json = _resp.content

返回值进行校验

if _resp.ok:
self.assertIsNotNone(resp_json)
LOG.info(‘update users, response: {0}’.format(resp_json))
else:
LOG.error(‘error update users, response: {0}, status: {1}’.format(resp_json, _resp.status_code))

接口：查询用户

根据用户名查询用户，使用http的get请求

@app.route(‘/guardian/users/string:user_name’, methods=[‘GET’]) # 查询使用 GET 方法
@require_role(‘guardian_admin’)
@login_required
def query_user_by_username(user_name):

try:
user_info = GuardianModelDao._query_users_info_by_name(user_name) # 调用后台查询函数
if len(user_info):
return wrap_response(jsonpickle.dumps(user_info), 200) # 成功返回200 并把返回内容转换成 json格式
else:
return wrap_response(“[]”, 200) # 否则返回空
except Exception as e:
LOG.exception(‘error query user by name’, e)
abort(500)

后台函数

@classmethod
def _query_users_info_by_id(cls, user_id):
LOG.debug(‘start list users info…’)
users = []
with TxConn() as conn:
try:
with conn.cursor() as cursor:
data = (user_id,)
cursor.execute(cls.query_users_info_by_id, data)

查询结构如果是行数据，放进list中进行返回

for (user_id, real_name, email, tel, phone, org_id, org_array, comments, create_time, update_time) in cursor:
user = Users(user_id, real_name, email, tel, phone, org_id, org_array, comments, create_time, update_time)
users.append(user)
except Exception as e:
LOG.exception(‘error query users !’)
raise e
return users

测试脚本(查询用户)

def test_query_user_api(self):

myheaders = {‘Content-Type’: ‘application/json’}
myheaders[‘X-Subject-Token’] = self.user_token

_resp = requests.get(self.guardian_base + ‘/guardian/users/tsbc’, headers=myheaders, verify=True) # 链接中加入用户名
resp_json = _resp.text

验证判断

if _resp.ok:
self.assertIsNotNone(resp_json)
LOG.info(‘query users, response: {0}’.format(resp_json))
else:
LOG.error(‘error query users, response: {0}, status: {1}’.format(resp_json, _resp.status_code)

接口：删除用户

根据用户ID进行删除，使用http的delete请求

@app.route(‘/guardian/users/string:user_id’, methods=[‘DELETE’]) # 传入用户id 使用 delete请求
@require_role(‘guardian_admin’)
@login_required
def delete_user(user_id):
if user_id is None:
abort(400)
try:
s_code = usermgt.delete_user(user_id)
if s_code == 204:
return wrap_response(SUCCESS_MSG, status=s_code) # 返回状态码
except Exception as e:
LOG.exception(‘error delete users info’, e)
abort(500)

后台函数

def delete_user(user_id):
myheaders = {‘Content-Type’: ‘application/json’}
myheaders[‘X-Auth-Token’] = settings.KEYSTONE_ADMIN_TOKEN
_resp = requests.delete(settings.KEYSTONE_BASE + ‘/v3/users/’+user_id,
headers=myheaders, verify=False)

if _resp.status_code == 204:
LOG.debug(‘delete users – response {0}’.format(_resp))
return _resp.status_code
else:
LOG.error(‘error list users, response: {0}’.format(_resp))
raise KeystoneException(‘error delete user {0} with response status {1}’
.format(user_id, _resp.status_code), _resp.status_code)

测试脚本(删除用户)​​​

点我全套软件测试(自动化测试)学习资料抱走【备注csdn000】学习资料抱走【备注csdn000】")

def test_delete_users_api(self):

myheaders = {‘Content-Type’: ‘application/json’}
myheaders[‘X-Subject-Token’] = self.user_token
_resp = requests.delete(self.guardian_base + ‘/guardian/users/tsbc1’, headers=myheaders, # 使用 delete 请求
verify=True)
resp_json = _resp.content

根据返回状态进行校验

if _resp.ok:
self.assertIsNotNone(resp_json)
LOG.info(‘delete users api, response: {0}’.format(resp_json))
else:
LOG.error(‘error delete users api, response: {0}, status: {1}’.format(resp_json, _resp.status_code))

下面提供给前端API文档

CREATE USER

1. URL:’ /guardian/users’

2. METHOD: POST

3. body:

{
“user”: {
“domain_id”: “default”,
“enabled”: True,
“name”: “tsbc1”,
“password”: “111111”,
“realname”: “Ray”,
“email”: “haoydun@123.com”,
“tel”:“+86-029-88880000”,
“phone”: “13800138000”,
“org_id”: “7d22d25a-b648-4ad3-a834-2398eb989a9e”,
“org_array”: null,
“comments”: “备注信息”
}
}

UPDATE USER

1. URL:’ /guardian/users/string:user\_id’

2. METHOD: PATCH

3. body:

{
“user”: {
“domain_id”: “default”,
“enabled”: True,
“name”: “tsbc1”,
“password”: “111111”,
“realname”: “Ray”,
“email”: “tsbc@vip.qq.com”,
“tel”:“+86-029-88880000”,
“phone”: “13800138000”,
“org_id”: “7d22d25a-b648-4ad3-a834-2398eb989a9e”,
“org_array”: null,
“comments”: “备注信息”
}
}

该接口可以用于修改密码，禁用用户

QUERY USER BY NAME

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注软件测试）

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
comments": “备注信息”
}
}

该接口可以用于修改密码，禁用用户

QUERY USER BY NAME

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注软件测试）
[外链图片转存中…(img-bDJwwgT1-1713293900540)]

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！