溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章主要介紹了在Web API程序中如何使用Swagger做接口文檔，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。
在VS2019中創建一個ASP.NET Web應用程序，選擇Web API來創建RESTful的HTTP服務項目，構選MVC和Web API核心引用。
使用NuGet包管理器，查找安裝Swashbuckle，也就是Swagger插件。
在APP_START里找到SwaggerConfig，大概在105行左右有對c.IncludeXmlComments的注釋，在此處添加配置：
c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
在SwaggerConfig的最后，給類添加方法：
protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.xml", System.AppDomain.CurrentDomain.BaseDirectory, name);
}維護好controller路徑中各個控制器接口方法的summary注釋。
在API項目的生成設置里，構選生成XML文檔文件。
編譯、運行程序，在打開的Web地址后加上swagger，可以看到自動生成的接口文檔和summary信息，可對接口進行測試。
感謝你能夠認真閱讀完這篇文章，希望小編分享的“在Web API程序中如何使用Swagger做接口文檔”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
