1. 程式人生 > >.Net WebApi入門簡單基礎認識(自動生成api文件和簡單測試)

.Net WebApi入門簡單基礎認識(自動生成api文件和簡單測試)

關於WebApi網上有很多官方的定義,具體的定義就不寫了,這篇文章大概介紹一下WebApi的基礎搭建。。關於我自己對WebApi的理解是“webapi是基於HTPP構建的服務框架,可以用於搭建基本全部的客戶端訪問的介面(例如瀏覽器、APP、智慧裝置等)”

新建WebApi專案
這裡寫圖片描述
選擇新建asp.net專案,選擇WebApi模板,其他預設就可以了!
這裡寫圖片描述
新建出來咋一看跟MVC的結構很相像,不過webapi不用管view頁面,新建控制器的時候選擇api控制器就好了!
這裡寫圖片描述
新建一個Logins登入的Api控制器
這裡寫圖片描述
WebApi方法命名有一定的格式(Http verb (GET, POST, PUT, DELETE)),如果你不按格式來就要自己方法頭部定義,自動生成的xml文件註釋是///裡面的註釋,先定義好註釋,然後開啟一下xml文件檔案,開啟webapi類庫的屬性(右鍵選擇屬性),開啟xml文件生成(如下圖),文件位置自己選擇,但要與Areas/HelpPage/App_Start/HelpPageConfig.cs檔案中如下圖的程式碼中的位置相同!
這裡寫圖片描述


這裡寫圖片描述
到這裡就能顯示中文文件
這裡寫圖片描述
隨便點進去一個,沒發現測試按鈕是因為沒有安裝相應的測試外掛,開啟Nuget管理控制器,安裝下下面圖片中的Nuget包就能整合簡單測試功能
這裡寫圖片描述
這裡寫圖片描述