本文介绍了测试WebAPI项目的方法,对大家的学习或工作有一定的参考价值。让我们和边肖一起学习。
如果项目是前端分离模式开发,我们的WebAPI最终需要提供给前端页面进行调用。
那么在对接之前,一定要保证我们的WebAPI没有bug。在这种情况下,开发者自己测试API就显得尤为重要。
建议以两种方式进行WebAPI测试:
(1)使用PostMan测试WebAPI;(2)整合霸气;在WebAPI中;
一、利用PostMan测试WebAPI
PostMan的安装和基本使用:
1.官方:https://www.postman.com/downloads/
2.启动后,可以跳过输入账号这一步。
3.单击编号或“新请求”创建新请求。
4.邮递员的工作界面
(1)测试Get接口类别:
公共课学生
{
公共字符串StuNo { get设置;}//学生ID
公共字符串StuName { get设置;}//名称
公共字符串StuSex { get设置;}//性别
公共学生(字符串编号、字符串名称、字符串性别)
{
这个。StuNo=否;这个。StuName=name这个。StuSex=性;
}
}
API接口:
公共列表Student Get()
{
list student list=new list student();
列表。添加(新生( 001 ,孙悟空,男);
列表。添加(新生( 002 ,猪八戒,男);
列表。添加(新生( 003 ,白,女));
退货单;
}
测试界面:
[1]输入API地址;[2]请求方法选择GET;
(2)测试POST接口[1]输入API地址;[2]选择岗位;作为请求方法;[3]在主体中输入请求主体中的参数名称和值;
类别:
公共课学生
{
公共字符串StuNo { get设置;}//学生ID
公共字符串StuName { get设置;}//名称
公共字符串StuSex { get设置;}//性别
公共学生(字符串编号、字符串名称、字符串性别)
{
这个。StuNo=否;这个。StuName=name这个。StuSex=性;
}
}
API接口:
公共IHttpActionResult帖子([FromBody]学生stu)
{
String=string.format(通过post type(学号:{0},姓名:{1},性别:{2}),stu.stuno,stu.stuname,stu.stusex)获取的数据);
返回Json(new { Msg=str });
}
测试界面:
(3)其它接口测试常见的接口类型有GET、POST、PUT和DELETE,其中PUT和DELETE的测试可以在后面的RESTFul API中完成。
二、在WebAPI中集成Swagger
使用WebAPI开发接口后,编写API描述文档比较繁琐,但有了Swagger,可以快速自动生成API描述。
Swagger是一个用于可视化生成、描述和调用WebAPI文档的规范而完整的框架。
[1]打开Nuget包管理软件,找到swagger,安装Swashbuckle组件。
[2]打开项目的XML注释位置(选择项目,右键-属性-生成-输出- XML文档文件)
[3]在App_Start中会自动生成SwaggerConfig配置文件,这个文件会被修改。
找到以下代码并修改版本号和标题:
C.singlapivision( v1 , chp 02-项目测试);
找到以下代码并打开注释:
//c . IncludeXmlComments(GetXmlCommentsPath());
添加GetXmlCommentsPath()函数,函数中的路径会填充步骤2中设置的路径。
公共静态字符串GetXmlCommentsPath()
{
返回$@{System。AppDomain . current domain . base directory } bin web application 1。XML ;
}
[4]通过以下地址访问Swagger UI:
http://本地主机:65075/swagger
如果Swagger UI中的中文字符出现乱码,您可以选择SwaggerConfig文件,选择文件-高级保存选项,并将编码设置为UTF-8。
[5]使用Swagger UI测试API接口:
这就是这篇关于测试ASP.Net web API项目的文章。希望对大家的学习有帮助,也希望大家多多支持。