說明:
1)以下以
.NET為開發平臺創建api接口,并且引入Swagger配置接口文檔
2)
代碼部分有點混亂,可轉到文章底部有文章鏈接查看一、創建Net Web API項目
1.新建web應用程序
2.選擇空模板,并且勾選web api
3.生成web api項目后,添加controller文件
4.自動回生成content、views等文件夾及文件
5.可直接運行,程序異常
6.Global.asax 添加配置
代碼如下:
7.修改路由配置,制定默認controller、action
代碼如下:
8.生成默認view
9.重新編譯,運行程序。成功顯示home的index頁面
二、引入Swagger
1.打開NuGet程序包
2.“瀏覽”頁簽下,搜索swagger, 找到swashbuckle,右側選擇webapi項目,進行安裝。
3.找到swagger.net.ui,右側選擇webapi項目,進行安裝。
4.安裝完成后,生成相關配置文件,可直接關閉掉nuget,
三、配置Swagger
1.修改默認頁(前面步驟中生成的HomeController的index頁面僅僅是測試用,到此步驟也可以刪除掉)
代碼如下:
2.運行程序,出現報錯,因為還缺少配置
3.打開應用程序屬性
選擇“生成”,勾選xml文檔,這個xml里面會自動配置swagger
4.打開SwaggerNet.cs,屏蔽如下兩行代碼。
5.重新運行,看到下面頁面則代表swagger配置成功。
四、編寫接口及調試
1.新建測試model
代碼如下:
2.新建一個測試controller
代碼如下:
3.重新運行,看到新建的接口。
4.點擊“TestAPI”,再點擊“api/TestAPI”可打開接口詳細內容。
5.接口測試。得到后臺返回響應,則接口陳宮
五、注意說明
接口地址為http://localhost:64530/api/TestAPI
可利用Postman做測試