接口自动化框架文档（自动生成api接口文档的框架）

网友投稿 257 2023-01-06

本篇文章给大家谈谈接口自动化框架文档，以及自动生成api接口文档的框架对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。今天给各位分享接口自动化框架文档的知识，其中也会对自动生成api接口文档的框架进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

1、北大青鸟设计培训：接口自动化测试框架？
2、怎么搭建 python 的接口自动化测试框架?
3、如何创建 python+requests接口自动化测试框架
4、一个简单的接口自动化框架

北大青鸟设计培训：接口自动化测试框架？

关于自动化测试项目中会分成许多的不同的测试模块，而今天我们就一起来了解一下，关于接口的自动化测试框架都有哪些比较常见的类型。
下面厦门java课程http://www.kmbdqn.cn/就开始今天的主要内容吧。
需求：1、接口编写方便。
2、方便调试接口。
3、支持数据初始化。
4、生成测试报告。
5、支持参数化。
robotframework优点关键字驱动，自定义用户关键字。
支持测试日志和报告生成。
支持系统关键字开发，可扩展性好。
支持数据库操作。
缺点接口测试用例写起来不简洁。
需要掌握特定语法。
结果：不考虑，没人愿意这么写接口用例。
JMeter优点支持参数化不需要写代码缺点创建接口用例效率不高。
不能生成查看每一个接口执行情况的测试报告。
总结：不考虑，接口编写不方便，主要是不能生成测试报告，如果做接口性能的话可以考虑。
HttpRunner优点:基于YAML/JSON格式，专注于接口本身的编写。
接口编写简单生成测试报告接口录制功能。
缺点:没有编辑器插件对语法校验，容易出错。
官方文档没有详细的说明。
扩展不方便。

接口自动化框架文档（自动生成api接口文档的框架）

怎么搭建 python 的接口自动化测试框架?

1.框架搭建
1.1 将struts2中的jar文件导入到项目中
commons-fileupload-1.2.1.jar,commons-io-1.3.2.jar,freemarker-2.3.15.jar,ognl-2.7.3.jar
struts2-core-2.1.8.1.jar,xwork-core-2.1.6.jar
1.2 将struts.xml文件拷贝到项目的src目录下
1.3 修改web.xml文件
添加：
<filter
<filter-namestruts2</filter-name
<filter-classorg.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class
</filter
<filter-mapping
<filter-namestruts2</filter-name
<url-pattern/*</url-pattern
</filter-mapping
2.action中方法的调用方式
2.1 自动方法调用（只能调用execute）
2.2 指定方法调用(通过设置action标签中的method属性)
2.3 动态方法调用(在调用时，在action后加！方法名称，如：login!deletUser)
注意：<constant name="struts.enable.DynamicMethodInvocation" value="true" /
2.4 通配符调用
3. action接收客户端参数的方式
3.1 直接在action中定义参数变量，并生成set和get方法
3.2 定义接收参数的类
注意：都要为action的成员变量提供get和set方法
3.3 让action实现ModelDriven接口，并实现里面的getModel方法
4.获取request，session，application的方式
4.1 用ActionContext获取,实际上获取到的都是Map对象
4.2 用ServletActionContext获取，获取到的是基于Servlet API的对象

如何创建 python+requests接口自动化测试框架

工作原理: 测试用例在excel上编辑，使用第三方库xlrd，读取表格sheet和内容，sheetName对应模块名，Jenkins集成服务发现服务moduleName查找对应表单，运用第三方库requests请求接口，根据结果和期望值进行断言，根据输出报告判断接口测试是否通过。
1. 数据准备
数据插入（容易实现的测试场景下所需外部数据)
准备sql （接口需要重复使用，参数一定得是变量)
2.集成部署(运维相关了解即可)
平滑升级验证脚本加入自动化
3.自动化框架实现
调用mysql
excel遍历测试用例
requests实现接口调用
根据接口返回的code值和Excel对比
报告反馈
暴露服务
写一个简单登录的接口自动化测试
代码的分层如下图：
coding.png
一、写一个封装的获取excel表格的模块
excel.png
代码实现如下：
# !/usr/bin/python
# -*- coding: UTF-8 -*-
# 基础包：excel的封装
import xlrd
workbook = None
def open_excel(path):
"""打开excel"""
global workbook
if (workbook == None):
workbook = xlrd.open_workbook(path, on_demand=True)
def get_sheet(sheetName):
"""获取行号"""
global workbook
return workbook.sheet_by_name(sheetName)
def get_rows(sheet):
"""获取行号"""
return sheet.nrows
def get_content(sheet, row, col):
"""获取表格中内容"""
return sheet.cell(row, col).value
def release(path):
"""释放excel减少内存"""
global workbook
workbook.release_resources()
del workbook
代码封装后当成模块引用，这还是最开始呢。
二、引用log模块获取日志
准备工作：
需要一个日志的捕获，包括框架和源码抛出的expection。
代码如下：
#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 基础包：日志服务
import logging
import time
def getLogger():
global tezLogPath
try:
tezLogPath
except NameError:
tezLogPath = "/data/log/apiTest/"
FORMAT = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
# file = tezLogPath + time.strftime("%Y-%m-%d", time.localtime()) + ".log"
# logging.basicConfig(filename=file, level=logging.INFO, format=FORMAT)
# 开发阶段为了方便调试，可不输出到文件
logging.basicConfig(level=logging.INFO, format=FORMAT)
return logging
三、引用requests模块接口测试
准备工作：
需要的请求类型和执行测试的方法。
代码如下：
#!/usr/bin/python#
#-*- coding: UTF-8 -*-
# 基础包：接口测试的封装
import requests
import tezLog as log
logging = log.getLogger()
def api_test(method, url, data ,headers):
"""
定义一个请求接口的方法和需要的参数
:Args:
method - 企业名称 str
url - 用户昵称 str
data - 参数 str
headers - 请求头信息 dict
非RESTful API请求另外的请求类型实际用不到。也不安全。
"""
try:
if method == "post":
results = requests.post(url, data, headers=headers)
if method == "get":
results = requests.get(url, data, headers=headers)
# if method == "put":
# results = requests.put(url, data, headers=headers)
# if method == "delete":
# results = requests.delete(url, headers=headers)
# if method == "patch":
# results == requests.patch(url, data, headers=headers)
# if method == "options":
# results == requests.options(url, headers=headers)
response = results.json()
code = response.get("code")
return code
except Exception, e:
logging.error("service is error", e)
def run_test(sheet):
"""
定义一个执行和断言的方法
:Args:
sheet - 服务名称 str（excel页脚名称识别的）
"""
rows = excel.getRows(sheet)
fail = 0
for i in range(2, rows):
#这里为什么从第二行开始跑，因为会先执行SQL进行数据准备如之前Excel展示的空白位置
testData = excel.getContent(sheet, i, gl.CASE_DATA)
testUrl = excel.getContent(sheet, i, gl.CASE_URL)
testMethod = excel.getContent(sheet, i, gl.CASE_METHOD)
testHeaders = eval(excel.getContent(sheet, i, gl.CASE_HEADERS))
testCode = excel.getContent(sheet, i, gl.CASE_CODE)
actualCode = request.apiTest(testMethod, testUrl, testData, testHeaders)
expectCode = str(int(testCode))
failResults = ' url: ' + testUrl + ' params: ' + testData + ' actualCode: ' + actualCode + ' expectCode: ' + expectCode
if actualCode == expectCode:
logging.info("pass")
elif actualCode != expectCode:
logging.info("fail %s", failResults)
fail += 1
if fail 0 :
return False
return True
四、关于参数中gl模块
准备工作：
所有的参数和常量我们会整理到这个文件中，因为设计业务和服务密码、数据库密码这里展示一部分。
代码如下：
#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 脚本功能：全部变量
import time
import uuid
CASE_NUMBER = 0 # 用例编号
CASE_NAME = 1 # 用例名称
CASE_DATA = 2 # 用例参数
CASE_URL = 3 # 用例接口地址
CASE_METHOD = 4 # 用例请求类型
CASE_CODE = 5 # 用例code
CASE_HEADERS = 6 # 用例headers
SQL_ROW = 0 # 预执行SQL的行号
SQL_COL = 1 # 预执行SQL的列号
五、写一个run文件：只是用来执行的，业务和代码剥离。
代码如下：
#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 验证包：接口测试脚本
import sys
import core.tezLog as log
import function.common as common
logging = log.getLogger()
"""1.外部输入参数"""
path = sys.path[0] # 当前路径
module = sys.argv[1] # 服务模块名
url = sys.argv[2] # 服务地址
host = sys.argv[3] # 数据库地址
user = sys.argv[4] # 数据库用户名
password = sys.argv[5] # 数据库密码
db = sys.argv[6] # 数据库名称
"""2.根据module获取Sheet"""
logging.info("-------------- Execute TestCases ---------------")
sheet = common.get_excel_sheet(path + "/" + common.filename, module)
"""3.数据准备"""
logging.info("-------------- Prepare data through MysqlDB --------------")
sql = common.get_prepare_sql(sheet)
common.prepare_data(host=host, user=user, password=password, db=db, sql=sql)
"""4.执行测试用例"""
res = common.run(sheet, url)
logging.info("-------------- Get the result ------------ %s", res)
"""这里的res是我们平滑升级的时候需要返回结果为TRUE才会继续下面走。"""
六、查看测试报告（部署到jenkins会通过控制台查看）

一个简单的接口自动化框架

Test_api.py:

1,MakeExcel:

2,OpJson.py:

3,ReadConf.py:

4,SendRequest.py

(6)conftest.py

(7)pytest.ini:

1,main.py:

2,执行结果:

3,产生的日志:

已实现接口自动化,某些地方可能还需优化; 关于接口自动化框架文档和自动生成api接口文档的框架的介绍到此就结束了，不知道你从中找到你需要的信息了吗？如果你还想了解更多这方面的信息，记得收藏关注本站。接口自动化框架文档的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于自动生成api接口文档的框架、接口自动化框架文档的信息别忘了在本站进行查找喔。

标签：接口文档 api接口文档 api 接口调用接口测试

暂时没有评论，来抢沙发吧~

接口自动化框架文档（自动生成api接口文档的框架）

北大青鸟设计培训：接口自动化测试框架？

怎么搭建 python 的接口自动化测试框架?

如何创建 python+requests接口自动化测试框架

一个简单的接口自动化框架

java 单机接口限流处理方案

29、OSPF配置实验之被动接口

接口测试的核心概念是什么

推荐文章

接口调用是什么意思？几种常用接口调用方式

接口设计原则

8款在线 API 接口文档管理工具

api管理系统是什么？

什么是接口调试？接口调试的步骤有哪些？

api 接口管理系统有哪些？

接口测试有几种测试方法

API文档生成工具有哪些？

微服务和api网关区别

交换机配置步骤

最近发表

热评文章

在线接口文档管理工具推荐，支持在线测试，HTTP接口

开源的在线接口文档wiki工具Mindoc的介绍与使

如何优雅的进行接口设计？接口设计的六大原则是什么？

什么是API测试,api检测公司

软件接口设计怎么做？前后端分离软件接口设计思路

接口管理平台推荐，几大接口管理平台总有一款适合你！