對ASP.Net的WebAPI項目進(jìn)行測試
如果項目采取前后端分離的模式進(jìn)行開發(fā)，那么我們的WebAPI最終是需要提供給前端頁面來進(jìn)行調(diào)用的。
那么在進(jìn)行對接之前必須要保證我們的WebAPI沒有Bug，在這種情況下作為開發(fā)者對API的自行測試就顯得尤為重要。
WebAPI的測試推薦兩種方式進(jìn)行：
- （1）使用PostMan測試WebAPI；
- （2）在WebAPI中集成Swagger；
一、利用PostMan測試WebAPI
PostMan的安裝和基本使用：
1.官方下載地址：https://www.postman.com/downloads/
2.啟動后可以跳過輸入賬號步驟
3.點擊+號或者“新建請求”來創(chuàng)建一個新的請求
4.PostMan的工作界面
（1）測試Get接口
實體類：
public class Student
{
public string StuNo { get; set; } //學(xué)號
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中輸入請求體中的參數(shù)名和值；
實體類：
public class Student
{
public string StuNo { get; set; } //學(xué)號
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類型獲取的數(shù)據(jù)(學(xué)號:{0},姓名:{1},性別:{2})", stu.StuNo, stu.StuName, stu.StuSex);
return Json(new { Msg = str });
}接口測試：
（3）其它接口測試
常見的接口類型有GET,POST,PUT,DELETE類型，其中PUT類型和DELETE類型的測試在學(xué)習(xí)后面的RESTFul API中可進(jìn)行。
二、在WebAPI中集成Swagger
在使用WebAPI開發(fā)完接口之后，編寫API說明文檔是一件繁瑣的事情，但是有了Swagger，就可以快速地自動生成API說明。
Swagger 是一個規(guī)范和完整的框架，用于可視化地生成、描述、調(diào)用WebAPI文檔。
【1】打開Nuget 包管理軟件，查找 swagger，進(jìn)行Swashbuckle 組件的安裝
【2】開啟項目的XML注釋位置（選中項目，右鍵-->屬性-->生成-->輸出-->XML文檔文件）
【3】在App_Start中中會自動生成SwaggerConfig配置文件，對此文件進(jìn)行修改。
找到如下代碼，修改版本號及標(biāo)題：
c.SingleApiVersion("v1", "Chp02-項目測試");
找到如下代碼，將注釋進(jìn)行打開:
//c.IncludeXmlComments(GetXmlCommentsPath());
添加GetXmlCommentsPath()函數(shù)，函數(shù)中的路徑填寫步驟2中設(shè)置的路徑
public static string GetXmlCommentsPath()
{
return $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\WebApplication1.XML";
}【4】訪問Swagger UI，通過如下地址訪問：
http://localhost:65075/swagger
如果Swagger UI中中文顯示亂碼，則可以選中SwaggerConfig文件，選擇文件-->高級保存選項，將編碼設(shè)置為UTF-8。
【5】利用Swagger UI進(jìn)行API接口的測試：
到此這篇關(guān)于測試ASP.Net WebAPI項目的文章就介紹到這了。希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
asp.net頁面觸發(fā)事件panel滾動條高度不變的實現(xiàn)方法
asp.net頁面按鈕點擊觸發(fā)事件后panel滾動條非自動回到頂端，每次都要往下拉一下，關(guān)于這個問題的解決方法如下2014-11-11
這篇文章主要給大家介紹了關(guān)于.NET發(fā)送郵件的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對大家學(xué)習(xí)或者使用.net具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-06-06
安全性是 ASP.NET Web 應(yīng)用程序中一個非常重要的方面,它涉及內(nèi)容非常廣泛,不能在一篇文章內(nèi)說明所有的安全規(guī)范,本文講述如何利用IIS以及Forms 身份驗證構(gòu)建安全的 ASP.NET 應(yīng)用程序,它是目前被使用最多最廣的驗證／授權(quán)方式.2009-12-12
這篇文章主要介紹了ASP.NET中圖片顯示方法,實例分析了ASP.NET圖片顯示所涉及的圖片路徑、縮略圖及更新數(shù)據(jù)庫圖片瀏覽次數(shù)等相關(guān)技巧,需要的朋友可以參考下2015-07-07
這篇文章主要介紹了最簡單的asp.net中的窗體身份驗證，詳細(xì)敘述了asp.net的窗體身份驗證步驟，感興趣的小伙伴們可以參考一下2015-09-09
asp.net 上傳或下載當(dāng)文件名包含有特殊字符"#"的處理
在上傳或下載文件時，當(dāng)文件名包含有"#"特殊字符時，上傳以后的文件會被改名字，造成下載也下載不了。2010-03-03
本文介紹了.net郵箱發(fā)布郵箱信息的實例代碼，需要的朋友可以參考一下2013-03-03
這篇文章主要為大家詳細(xì)介紹了ASP.NET生成驗證碼的方法，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-05-05
asp.net使用for循環(huán)實現(xiàn)Datalist的分列顯示功能
工程業(yè)績--用for循環(huán)代替了DataList多列顯示，得到2行四列的表格，需要內(nèi)存表的8行數(shù)據(jù)2009-12-12
.net使用jwt進(jìn)行身份認(rèn)證的流程記錄
這篇文章主要給大家介紹了關(guān)于.net使用jwt進(jìn)行身份認(rèn)證的相關(guān)資料,JWT是Auth0提出的通過對JSON進(jìn)行加密簽名來實現(xiàn)授權(quán)驗證的方案,本文通過示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2021-09-09