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接口的測試：