這篇文章主要介紹了在Web API程序中如何使用Swagger做接口文檔，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

創(chuàng)新互聯(lián)是一家業(yè)務范圍包括IDC托管業(yè)務,網(wǎng)絡空間、主機租用、主機托管，四川、重慶、廣東電信服務器租用,成都托管服務器，成都網(wǎng)通服務器托管,成都服務器租用,業(yè)務范圍遍及中國大陸、港澳臺以及歐美等多個國家及地區(qū)的互聯(lián)網(wǎng)數(shù)據(jù)服務公司。

創(chuàng)建Web API程序

在VS2019中創(chuàng)建一個ASP.NET Web應用程序，選擇Web API來創(chuàng)建RESTful的HTTP服務項目，構(gòu)選MVC和Web API核心引用。

安裝Swashbuckle

使用NuGet包管理器，查找安裝Swashbuckle，也就是Swagger插件。

配置SwaggerConfig

在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);
}

維護接口方法的Summary

維護好controller路徑中各個控制器接口方法的summary注釋。

生成項目的XML文檔文件

在API項目的生成設置里，構(gòu)選生成XML文檔文件。

編譯并運行程序

編譯、運行程序，在打開的Web地址后加上swagger，可以看到自動生成的接口文檔和summary信息，可對接口進行測試。

感謝你能夠認真閱讀完這篇文章，希望小編分享的“在Web API程序中如何使用Swagger做接口文檔”這篇文章對大家有幫助，同時也希望大家多多支持創(chuàng)新互聯(lián)，關注創(chuàng)新互聯(lián)-成都網(wǎng)站建設公司行業(yè)資訊頻道，更多相關知識等著你來學習!

名稱欄目：在WebAPI程序中如何使用Swagger做接口文檔-創(chuàng)新互聯(lián)
分享鏈接：http://weahome.cn/article/dpieed.html