1. 程式人生 > 其它 >WebAPI系列之快速入門

WebAPI系列之快速入門

前言

隨著上位機開發技術的廣泛應用,很多小夥伴會有上位機與MES等系統進行資料互動的需求,這時候,我們就需要了解WebAPI的相關技術。

什麼是WebAPI?

WebAPI是一個簡單的構建HTTP服務的新框架,用於對接各種客戶端(瀏覽器,移動裝置),在.Net平臺上,WebAPI是一個開源的、理想的、構建REST-ful服務的技術。

WebAPI部署在哪裡?

WebAPI部署在IIS中,用於給外部應用提供資料。

為什麼要使用WebAPI?

WebAPI本質是網路應用程式介面,網路應用可以通過API介面,可以實現儲存服務、訊息服務、計算服務等能力,利用這些能力可以進行開發出強大功能的web應用。

建立WebAPI

1、開啟VS2019,建立一個新專案,專案模板選擇ASP.NET Web應用程式(.NET Framework),如下所示:

2、建立完成後,取一個專案名稱,然後點選下一步,在下面的頁面中,選擇模板為Web API,如下所示:

3、建立專案需要一點時間,由於我們選擇好了Web API,所以建立好的專案介面自動會新增好Models/Controllers/Views等資料夾,如下所示:

4、在Models資料夾下,建立一個實體類,如下所示:

5、在Controllers資料夾下,右擊建立控制器,這裡注意要選擇Web API 2控制器模板,名稱為THMonitorController,繼承ApiController,如下所示:

6、在THMonitorController控制器中,建立一個實體集合物件,同時新增兩個Get開頭的方法,如下所示:

7、這樣,最簡單的一個WebAPI專案就完成了,直接執行即可,執行地址為https://localhost:44382/。

Web API測試

使用Postman介面工具來進行測試。

Postman是一款功能強大的HTTP除錯與模擬外掛。獲取安裝包,搜公眾號:dotNet工控上位機 後臺回覆Postman

1、啟動Postman之後,在位址列輸入https://localhost:44382/,如果要獲取所有的資料,請求方式選擇Get,位址列後面加個api/THMonitor,點選Send,可以看到返回的資料,結果顯示為JSON格式。

2、如果想要查詢某個資料,可以加個引數,位址列為https://localhost:44382/api/THMonitor?Name=溫度1,查詢結果如下所示:

3、位址列格式可以參考專案中的WebApiConfig.cs檔案: