对ASP.Net的WebAPI项目进行测试
如果项目采取前后端分离的模式进行开发，那么我们的WebAPI最终是需要提供给前端页面来进行调用的。
那么在进行对接之前必须要保证我们的WebAPI没有Bug，在这种情况下作为开发者对API的自行测试就显得尤为重要。
WebAPI的测试推荐两种方式进行：
- （1）使用PostMan测试WebAPI；
- （2）在WebAPI中集成Swagger；
一、利用PostMan测试WebAPI
PostMan的安装和基本使用：
1.官方下载地址：https://www.postman.com/downloads/
2.启动后可以跳过输入账号步骤
3.点击+号或者“新建请求”来创建一个新的请求
4.PostMan的工作界面
（1）测试Get接口
实体类：
public class Student
{
public string StuNo { get; set; } //学号
public string StuName { get; set; } //姓名
public string StuSex { get; set; } //性别
public Student(string no, string name, string sex)
{
this.StuNo = no; this.StuName = name; this.StuSex = sex;
}
}API接口：
public List<Student> Get()
{
List<Student> list = new List<Student>();
list.Add(new Student("001", "孙悟空", "男"));
list.Add(new Student("002", "猪八戒", "男"));
list.Add(new Student("003", "白骨精", "女"));
return list;
}接口测试：
- 【1】输入API地址；
- 【2】请求方法选择GET；
（2）测试POST接口
- 【1】输入API地址；
- 【2】请求方法选择POST；
- 【3】在Body中输入请求体中的参数名和值；
实体类：
public class Student
{
public string StuNo { get; set; } //学号
public string StuName { get; set; } //姓名
public string StuSex { get; set; } //性别
public Student(string no, string name, string sex)
{
this.StuNo = no; this.StuName = name; this.StuSex = sex;
}
}API接口：
public IHttpActionResult Post([FromBody] Student stu)
{
string str = string.Format("Post类型获取的数据(学号:{0},姓名:{1},性别:{2})", stu.StuNo, stu.StuName, stu.StuSex);
return 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.SingleApiVersion("v1", "Chp02-项目测试");
找到如下代码，将注释进行打开:
//c.IncludeXmlComments(GetXmlCommentsPath());
添加GetXmlCommentsPath()函数，函数中的路径填写步骤2中设置的路径
public static string GetXmlCommentsPath()
{
return $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\WebApplication1.XML";
}【4】访问Swagger UI，通过如下地址访问：
http://localhost:65075/swagger
如果Swagger UI中中文显示乱码，则可以选中SwaggerConfig文件，选择文件-->高级保存选项，将编码设置为UTF-8。
【5】利用Swagger UI进行API接口的测试：
到此这篇关于测试ASP.Net WebAPI项目的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
asp.net页面触发事件panel滚动条高度不变的实现方法
asp.net页面按钮点击触发事件后panel滚动条非自动回到顶端，每次都要往下拉一下，关于这个问题的解决方法如下2014-11-11
这篇文章主要给大家介绍了关于.NET发送邮件的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用.net具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2018-06-06
安全性是 ASP.NET Web 应用程序中一个非常重要的方面,它涉及内容非常广泛,不能在一篇文章内说明所有的安全规范,本文讲述如何利用IIS以及Forms 身份验证构建安全的 ASP.NET 应用程序,它是目前被使用最多最广的验证／授权方式.2009-12-12
这篇文章主要介绍了ASP.NET中图片显示方法,实例分析了ASP.NET图片显示所涉及的图片路径、缩略图及更新数据库图片浏览次数等相关技巧,需要的朋友可以参考下2015-07-07
这篇文章主要介绍了最简单的asp.net中的窗体身份验证，详细叙述了asp.net的窗体身份验证步骤，感兴趣的小伙伴们可以参考一下2015-09-09
asp.net 上传或下载当文件名包含有特殊字符"#"的处理
在上传或下载文件时，当文件名包含有"#"特殊字符时，上传以后的文件会被改名字，造成下载也下载不了。2010-03-03
本文介绍了.net邮箱发布邮箱信息的实例代码，需要的朋友可以参考一下2013-03-03
这篇文章主要为大家详细介绍了ASP.NET生成验证码的方法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2020-05-05
asp.net使用for循环实现Datalist的分列显示功能
工程业绩--用for循环代替了DataList多列显示，得到2行四列的表格，需要内存表的8行数据2009-12-12
这篇文章主要给大家介绍了关于.net使用jwt进行身份认证的相关资料,JWT是Auth0提出的通过对JSON进行加密签名来实现授权验证的方案,本文通过示例代码介绍的非常详细,需要的朋友可以参考下2021-09-09
最新评论