API测试自动化教程:一个循序渐进的指南

贵公司写一个API的软件吗?188金宝搏官网登录app如果答案是肯定的,那么你绝对需要测试它,幸运的是你,本教程一步一步解释如何进行自动化API测试使用工具像邮差,纽曼,詹金斯和188金宝搏app苹果下载软件Tricentis qt。

但首先,让我们的土地。原来你的软件的API实际上是最重要的188金宝搏官网登录app部分,你可以测试应用程序,因为它有最高的安全风险。

例如,浏览器或应用程序,客户端软件可以防止很多糟糕的用户体验,如发送100用户名或允许奇怪的编码字符输入,但你的API阻止这些事情吗?188金宝搏官网登录app如果有人开始猜测其他用户的“独特”的令牌,软件应对真正的数据吗?188金宝搏官网登录app它有一个Apache错误消息,包括服务运行的版本吗?如果这些问题的答案是是的,有一个相当大的安全缺陷。或者如果有人破解API呢?他们能生产数据,比特币赎金服务器机器上也可以隐藏,直到有有趣的事情发生了。底线是,使用API时的风险远高于如果只有一个错误在您的应用程序的UI——你的数据可能面临风险,通过代理,所有用户的数据。

幸运的是,API测试不仅是最重要的测试要做对您的应用程序,但它也是最简单和最快的执行。这意味着没有理由你不应该有一个广泛的API测试套件(相信我,有一个会帮你晚上睡得更好)。有了一个API测试套件和你持续集成可以很容易地:

• 测试你的所有端点无论在哪里举办,从AWSλ到本地机器上。
• 确保你所有的服务按预期运行。
• 确认你所有的端点安全从未经授权的和未经身份验证的用户。
• 看您的测试执行“神奇”填充您的测试管理工具。

那么如何把所有这一切付诸行动?你来对地方了。读了一个按部就班的API测试教程如何设置邮递员,纽曼,如何从詹金斯执行您的测试,最后如何将所有这些测试结果集成到测试管理工具如qt经理。

让我们开始吧!

建立了邮递员

1)首先第一:你需要下载邮差。它是免费的,十分有趣,它作用于Mac, Windows和Linux机器。注意:如果你有一个大的团队,您经常更新你的服务和测试,你可能想要考虑邮差Pro(但你可以决定升级后)。

2)确保应用程序的API文档方便。这个演示,我将使用Tricentis qt管理器API的简单的和公众。188金宝搏app苹果下载软件如果你想试试这些演示逐字,你可以得到一个审判Tricentis qt经理免费188金宝搏app苹果下载软件在这里。网上还有大量的api,您可以使用(我推荐入手AnyAPI如果你想要其他地方)。

3)接下来,打开登录调用API的文档你使用(你可以找到的文档Tricentis qt下面的经理)。188金宝搏app苹果下载软件这个文档应该包括:

• 方法(POST / PUT /会/删除/等)
• URI (/ oauth /令牌将遵循qt的实例使用的URL)
• 头
• 身体

在这个例子中,登录调用需要x-www-form-urlencoded - type头。你可以选择它在邮递员,它会自动添加适当的头。一旦你选择了这个选项,邮递员将允许您为格兰特类型,输入名称/值对用户名和密码。注意:任何时候你打电话,确保您的web协议是HTTPS,否则你的所有数据在互联网上以明文,没人想要。

4)如果你使用Tricentis qt188金宝搏app苹果下载软件经理,继续和结构测试,并写出是什么你想要测试的测试用例。当我们完成了,我们将链接的测试用例的自动化API测试测试用例ID映射。一般来说,先编写测试应该做什么在你的测试用例管理工具是一个伟大的过程编写自动化测试用例。

5)一旦你结构测试和写什么您想要您的测试用例,完整的可追溯性链接,你的要求,然后钩你的自动化测试执行测试用例。如果你使用一个工具像qt经理JIRA的链接,你会看到你所有的文本执行JIRA对于每一个匹配的要求。很酷,不是吗?

6)现在让我们使我们的第一个电话登录终端,这样我们可以得到一个令牌(稍后我们会令牌传递给后续调用API知道我们登录)。查看登录文档,我看到这是一个POST请求。如果是,你会通过URL传递您的用户名和密码。为了确保一切顺利进行,确保你有以下设置:

• 方法:文章
• URL: http://your.qTestURL/oauth/token
• 点击身体x-www-form-urlencoded选项卡并设置请求主体(这些只是不同的标准方法来传递数据的身体你的HTTP请求),单击单选按钮仅仅是一个HTTP报头字段内容类型设置为application / x-www-form-urlencoded。
• 现在体内设置3名称/值:
  • grant_type:密码
  • 用户名:你的qt的用户名
  • 密码:您的qt密码

注意命令在API文档关于密码没有被填写,名称/密码地区在邮递员提供的字段。

7)你的设置相匹配吗?太棒了!现在你有一个工作的API调用。让我们保存它到邮递员收集以后我们可以重用它。创建一个新的邮差收集,只需点击文件夹图标,再加上,在左边的面板。

一旦您创建了集合,您可以通过单击“保存”按钮保存你的电话在屏幕的右上角(标准操作系统快捷方式)。我叫API调用qt的测试用例ID。以后这将允许我地图我的测试用例,这样我可以跟踪每次我运行这个API调用连同我剩下的测试。

8)只有一个步骤在我们写一个测试之前,我们需要做的几件事与HTTP响应:

• 验证码是200 (OK)状态
• 确认你回到一个非空访问令牌
• 验证您的范围是准确的

注意,我们不关心其他字段——他们测试对你并不重要,你登录。

9)现在是时候写第一个测试!小心不要让你的测试脆性——聪明你测试和为什么你测试它。

10)接下来,让我们编写另一个测试将测试用例添加到我们现有的项目。首先,我们需要登录和保存我们的令牌。我们将创建一个环境变量,称之为“access_token”:

这个访问令牌存储的美是现在可以在后续的调用中使用它。这意味着您可以自动化测试和您不需要手动让你每次登录令牌。太好了!在接下来的电话,你会看到令牌使用双花括号{{access_token}}。

11)让我们看看文档添加一个测试用例,你能找到这里吗:

然后创建一个新的测试用例:

12)现在让我们创建新的POST请求添加一个测试用例。有一个变量URL(路径)称为{项目}。填写这个变量,我们需要在qt的ID项目,我们可以从qt的URL。在这种情况下,你可以看到它的45625:

我们还需要填写这些字段的字符串:

• 名称:测试创建测试用例
• 描述:这个测试用例是由API测试
• parent_id: 2656708

注意parent_id文件夹/模块我们刚刚创建的ID为这些测试会倾倒。ID可以在测试模块页面的URL。

13)接下来,我们要将注意力转向我们的两个数组属性。test_steps,这将是一个JSON数组,它是一个逗号分隔的列表JSON对象之间的两个方括号内。每个对象都是一个步骤,每一个JSON对象数组中的字符串应该引号内。小心不要复制在“引用”从一个Microsoft Word文档或其他来源,额外的美化你的文本。

Test_steps:

“test_steps”: [{

“描述”:“第一步,打开登录页面”,

“预期”:“登录页面打开,很明显”,

“附件”:[]

},

{

“描述”:“步骤2 -登录与愉快路径”,

“预期”:“用户被重定向到主屏幕”,

“附件”:[]

},

{

“描述”:“步骤3——点击汉堡酒吧”,

“预期”:“菜单显示”,

“附件”:[]

})

14)最后一个请求头从第一次调用使用令牌。正如前面所提到的,我们可以使用一个变量保存与双括号{{}}:

和请求主体:

然后几个测试:

验证响应,进入测试选项卡并确保你得到正确的数据。

15)现在可以运行整个测试套件或者子文件夹立刻使用“跑步者”。

这些大多是快乐的路径,但也有不少事情可能出错,这些调用,数十或数百个测试,你可以做,包括相当多的安全测试。客户如果项目属于另一个什么?如果模块ID不存在什么?如果你上传一个文件,是巨大的吗?编写一次,测试每一个时间!

一个大的项目我们没有涉及被存储在不同的环境中。如果你想测试你的开发、QA、分段或生产环境中,你可能有不同的测试数据为每个环境或登录你想使用。可以和选择环境在运行测试时通过GUI(我们)或与纽曼从命令行。让我们做下一个。

建立了纽曼
现在,您已经有了一个集合,您想要执行,也许一个相应的环境配置,您需要从命令行运行它。你必须能够以运行它从詹金斯或任何其他持续集成调度程序。要做到这一点,我建议纽曼,这是一个可执行程序运行Javascript编写的邮差的集合,可以安装包管理器的节点(NPM)。它只需要几个步骤:

1)打开你的终端/命令行应用程序的选择:https://www.davidbaumgold.com/tutorials/command-line/

2)安装NPM:https://www.npmjs.com/get-npm

3)在你的机器上安装纽曼全球:https://www.npmjs.com/package/newman/tutorial

4)从邮递员出口集合(右键单击测试你想出口在左窗格中)和出口环境(去“管理环境”,点击下载按钮)从邮递员。将这些文件保存在您的机器上你在哪里在你的终端导航。

5)一旦你在你的终端,没有什么剩下要做但运行您的测试!在这种情况下,您不需要任何选项或环境变量,所以命令应该说:

“纽曼运行路径/ /我/出口/ json /邮差/ collection.json '

看起来漂亮,对吗?很是伟大的,但当你使用詹金斯!让我们使用一个更典型的JUnit输出詹金斯能理解。喜欢的东西:

“纽曼记者junit运行,json路径/ /我/出口/ json /邮差/ collection.json

此命令实际上产生两种类型的输出:一个标准,更少的描述性JUnit以及高度描述性. json文件。看看两下——他们应该创建一个文件夹叫“纽曼”在您的工作目录(即您跑纽曼命令的目录)。

我们很快要编写一个脚本上传测试结果qt和使用JUnit输出允许詹金斯显示系统内置的图表,帮助通过或失败构建没有任何额外的帮助。

虽然你也可以上传结果直接qt经理使用JUnit的结果和自动化的内容,使用的API提供了更多的灵活性和测试结果出现在工具的地方。

现在,我们已经从命令行运行测试,是时候把这个放进我们的詹金斯的工作,因此它可以包括持续集成的一部分。我建议这对你的开发环境中运行每次开发人员努力工作分支。
从詹金斯执行您的测试
我不会进入詹金斯的设置,配置工作,但是这是在本地下载页面,如果你想试一试。

如果你不想安装詹金斯直接在您的机器上,您可以安装它码头工人。如果你想使用码头工人,你可以开始通过下载事实上的詹金斯码头工人实例和改变Dockerfile包括节点使用以下节点安装代码中发现的码头工人/ Jenkins库:

#安装节点

运行curl https://deb.nodesource.com/setup_4.x sl | bash

运行安装nodejs apt-get - y

运行节点- v

运行npm - v

纽曼运行npm安装- g

在这里,您将需要重建码头工人图像,然后启动容器在这个GitHub ReadMe相同的指令。

您现在应该拥有一个完全詹金斯实例安装在本地工作。太棒了!现在回到手头的任务使用新任詹金斯的实例:

1)创建一个新的在詹金斯“自由式”类型的工作。

在本例中,我们将设置它允许你上传集合作为一个参数。用您自己的项目,当你这样做时你应该提交邮递员收集到的任何库使用,直接从存储库来构建通过选择“这个项目是参数化”,然后选择“添加参数”与“文件参数。”

2)选择两个文件上传——一个用于收集和一个用于环境。

3)添加一个post-build与“执行Shell”(或“执行Windows批处理命令”如果你詹金斯是运行在Windows机器上的)。您将使用相同的命令你过去从命令行运行它自己(假设你使用相同的操作系统)早些时候除了你的道路现在应该只是收集。js,命名为“纽曼收集运行。json文件中的参数名称字段。

4)现在进行测试和运行构建。我刚上传的集合。json,因为我没有使用环境文件,但是你可以将它添加到命令行:

“纽曼收集运行。json - e environment.json”

以确保一切工作,检查测试所做的——应将一些新的测试用例添加到您的项目。

此外,如果您想要使用内置的JUnit詹金斯查看器,可以存档XML测试结果和测试点。这里有一个样品如何存档并使用JUnit测试的结果。如果你使用Tricentis q188金宝搏app苹果下载软件t经理,你也可以下载詹金斯qt管理器插件在这里。

通过API qt上传结果

在这一点上,我们已经成功运行的笔试CI工作。我们可以构建失败如果测试失败(API测试好主意!),但是我认为我们也应该上传测试结果Tricentis qt给这些测试通过或失败的证据。188金宝搏app苹果下载软件要做到这一点,我们可以使用一个脚本,我写道,你能找到这里吗。

1)使用这个脚本,我们将使用从纽曼. json的记者。

纽曼在那个文件夹,你应该找到你的样品测试结果。如果你想尝试这个节点脚本没有设置测试邮递员,你可以,但是你想要修改. json测试结果文件匹配数据与自己的项目。在下面的示例中,您将想要改变测试用例id匹配测试用例id从您自己的项目。

2)现在我们运行的脚本命令

节点uploadNewmanToQTest。js - f newman-json-result。json - c信誉。json -我真的- r”([0 - 9] +) - * ?”

后的部分- r选项有点吓人。这是一个JavaScript的正则表达式告诉脚本在哪里寻找测试用例ID(或名称如果我假在场)。这让第一位,并使用它们作为测试用例ID。默认情况下,结果整个测试用例名称将使用如果没有提供的正则表达式。例如,如果测试用例的名字是“验证成功登录”和我假(使用测试用例名称而不是ID),那么它将寻找一个相应的测试用例的名称“验证成功登录。“当然,如果这个名字出现两次,它将更新相关的测试运行与测试用例。这个脚本有很多选择,但并不是所有的都完成了。如果有你想看到的东西,不要犹豫或发表评论Tricentis直线下降188金宝搏app苹果下载软件。

就是这样,你应该得到一个成功的输出!

当然,这只是一个例子如何做的许多API测试。你也可以看看这个邮递员教程和这个邮递员&詹金斯介绍为更加伟大的信息。

如果你有任何特定的请求,请在下面发表评论,我会做我最好的回应。否则,测试快乐!