.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包就能集成簡單測試功能
這裏寫圖片描述
這裏寫圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章