網(wǎng)站首頁(yè) 編程語(yǔ)言 正文
如果項(xiàng)目采取前后端分離的模式進(jìn)行開(kāi)發(fā),那么我們的WebAPI最終是需要提供給前端頁(yè)面來(lái)進(jìn)行調(diào)用的。
那么在進(jìn)行對(duì)接之前必須要保證我們的WebAPI沒(méi)有Bug,在這種情況下作為開(kāi)發(fā)者對(duì)API的自行測(cè)試就顯得尤為重要。
WebAPI的測(cè)試推薦兩種方式進(jìn)行:
- (1)使用PostMan測(cè)試WebAPI;
- (2)在WebAPI中集成Swagger;
一、利用PostMan測(cè)試WebAPI
PostMan的安裝和基本使用:
1.官方下載地址:https://www.postman.com/downloads/
2.啟動(dòng)后可以跳過(guò)輸入賬號(hào)步驟
3.點(diǎn)擊+號(hào)或者“新建請(qǐng)求”來(lái)創(chuàng)建一個(gè)新的請(qǐng)求
4.PostMan的工作界面
(1)測(cè)試Get接口
實(shí)體類(lèi):
public class Student
{
public string StuNo { get; set; } //學(xué)號(hào)
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;
}
接口測(cè)試:
- 【1】輸入API地址;
- 【2】請(qǐng)求方法選擇GET;
(2)測(cè)試POST接口
- 【1】輸入API地址;
- 【2】請(qǐng)求方法選擇POST;
- 【3】在Body中輸入請(qǐng)求體中的參數(shù)名和值;
實(shí)體類(lèi):
public class Student
{
public string StuNo { get; set; } //學(xué)號(hào)
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類(lèi)型獲取的數(shù)據(jù)(學(xué)號(hào):{0},姓名:{1},性別:{2})", stu.StuNo, stu.StuName, stu.StuSex);
return Json(new { Msg = str });
}
接口測(cè)試:
(3)其它接口測(cè)試
常見(jiàn)的接口類(lèi)型有GET,POST,PUT,DELETE類(lèi)型,其中PUT類(lèi)型和DELETE類(lèi)型的測(cè)試在學(xué)習(xí)后面的RESTFul API中可進(jìn)行。
二、在WebAPI中集成Swagger
在使用WebAPI開(kāi)發(fā)完接口之后,編寫(xiě)API說(shuō)明文檔是一件繁瑣的事情,但是有了Swagger,就可以快速地自動(dòng)生成API說(shuō)明。
Swagger 是一個(gè)規(guī)范和完整的框架,用于可視化地生成、描述、調(diào)用WebAPI文檔。
【1】打開(kāi)Nuget 包管理軟件,查找 swagger,進(jìn)行Swashbuckle 組件的安裝
【2】開(kāi)啟項(xiàng)目的XML注釋位置(選中項(xiàng)目,右鍵-->屬性-->生成-->輸出-->XML文檔文件)
【3】在App_Start中中會(huì)自動(dòng)生成SwaggerConfig配置文件,對(duì)此文件進(jìn)行修改。
找到如下代碼,修改版本號(hào)及標(biāo)題:
c.SingleApiVersion("v1", "Chp02-項(xiàng)目測(cè)試");
找到如下代碼,將注釋進(jìn)行打開(kāi):
//c.IncludeXmlComments(GetXmlCommentsPath());
添加GetXmlCommentsPath()函數(shù),函數(shù)中的路徑填寫(xiě)步驟2中設(shè)置的路徑
public static string GetXmlCommentsPath()
{
return $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\WebApplication1.XML";
}
【4】訪(fǎng)問(wèn)Swagger UI,通過(guò)如下地址訪(fǎng)問(wèn):
http://localhost:65075/swagger
如果Swagger UI中中文顯示亂碼,則可以選中SwaggerConfig文件,選擇文件-->高級(jí)保存選項(xiàng),將編碼設(shè)置為UTF-8。
【5】利用Swagger UI進(jìn)行API接口的測(cè)試:
原文鏈接:https://www.cnblogs.com/wml-it/p/15966294.html
相關(guān)推薦
- 2022-01-18 獲取當(dāng)前的日期 格式為YYYY-MM-dd 和時(shí)間戳轉(zhuǎn)時(shí)間
- 2022-11-08 background-image 背景平鋪方式、 CSS3 background-size背景圖像大
- 2022-04-10 Python語(yǔ)言實(shí)現(xiàn)科學(xué)計(jì)算器_python
- 2022-06-25 JQuery選擇器用法詳解_jquery
- 2022-06-25 C++文件讀寫(xiě)操作詳解_C 語(yǔ)言
- 2023-02-17 pytorch/transformers?最后一層不加激活函數(shù)的原因分析_python
- 2022-01-12 cesium polygon添加邊界線(xiàn)不起作用
- 2022-04-02 ?Python錯(cuò)誤與異常處理_python
- 最近更新
-
- window11 系統(tǒng)安裝 yarn
- 超詳細(xì)win安裝深度學(xué)習(xí)環(huán)境2025年最新版(
- Linux 中運(yùn)行的top命令 怎么退出?
- MySQL 中decimal 的用法? 存儲(chǔ)小
- get 、set 、toString 方法的使
- @Resource和 @Autowired注解
- Java基礎(chǔ)操作-- 運(yùn)算符,流程控制 Flo
- 1. Int 和Integer 的區(qū)別,Jav
- spring @retryable不生效的一種
- Spring Security之認(rèn)證信息的處理
- Spring Security之認(rèn)證過(guò)濾器
- Spring Security概述快速入門(mén)
- Spring Security之配置體系
- 【SpringBoot】SpringCache
- Spring Security之基于方法配置權(quán)
- redisson分布式鎖中waittime的設(shè)
- maven:解決release錯(cuò)誤:Artif
- restTemplate使用總結(jié)
- Spring Security之安全異常處理
- MybatisPlus優(yōu)雅實(shí)現(xiàn)加密?
- Spring ioc容器與Bean的生命周期。
- 【探索SpringCloud】服務(wù)發(fā)現(xiàn)-Nac
- Spring Security之基于HttpR
- Redis 底層數(shù)據(jù)結(jié)構(gòu)-簡(jiǎn)單動(dòng)態(tài)字符串(SD
- arthas操作spring被代理目標(biāo)對(duì)象命令
- Spring中的單例模式應(yīng)用詳解
- 聊聊消息隊(duì)列,發(fā)送消息的4種方式
- bootspring第三方資源配置管理
- GIT同步修改后的遠(yuǎn)程分支