webapi 利用webapiHelp和swagger生成接口文檔

webapi 利用webapiHelp和swagger生成接口文檔。均依賴xml(需容許項目生成註釋xml)git

webapiHelp:微軟技術自帶,僅含有模塊、方法、請求-相應參數的註釋。web

swagger:除了上述,還能夠執行請求、獲取響應等json

詳細可看代碼:https://gitee.com/nlh774/AspNetWebApiStudy   我是分步驟提交git的,因此應該很清楚。api

後期該項目會不斷擴充,做爲我的持續研究webapi的筆記restful

 

另外,還能夠利用vs2017 添加rest api客戶端  生成調用方法,我本身寫的demo   https://gitee.com/nlh774/AspNetWebApiStudyasp.net

主要參考 https://www.red-gate.com/simple-talk/dotnet/net-development/visual-studio-2017-swagger-building-documenting-web-apis/visual-studio

如下2篇瞭解便可,沒多大用暫時ui

https://code-maze.com/different-ways-consume-restful-api-csharp/.net

https://docs.microsoft.com/en-us/dotnet/csharp/tutorials/console-webapiclientrest

 

webapi目前我我的只是瞭解階段,還不能大規模應用。其實我看上的是他的Rest風格+swaggerUI+vs2017「添加rest api客戶端「生成調用方法,很是節省開發對接時間。

本人目前對MVC的api熟悉(就是本質是asp.net MVC,只是返回json)

相關文章
相關標籤/搜索