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

目前創(chuàng)新互聯(lián)已為成百上千家的企業(yè)提供了網(wǎng)站建設(shè)、域名、網(wǎng)絡(luò)空間、成都網(wǎng)站托管、企業(yè)網(wǎng)站設(shè)計(jì)、滿洲網(wǎng)站維護(hù)等服務(wù)，公司將堅(jiān)持客戶導(dǎo)向、應(yīng)用為本的策略，正道將秉承"和諧、參與、激情"的文化，與客戶和合作伙伴齊心協(xié)力一起成長(zhǎng)，共同發(fā)展。

創(chuàng)建Web API程序

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

安裝Swashbuckle

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

配置SwaggerConfig

在APP_START里找到SwaggerConfig，大概在105行左右有對(duì)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);
}

維護(hù)接口方法的Summary

維護(hù)好controller路徑中各個(gè)控制器接口方法的summary注釋。

生成項(xiàng)目的XML文檔文件

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

編譯并運(yùn)行程序

編譯、運(yùn)行程序，在打開的Web地址后加上swagger，可以看到自動(dòng)生成的接口文檔和summary信息，可對(duì)接口進(jìn)行測(cè)試。

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享的“在Web API程序中如何使用Swagger做接口文檔”這篇文章對(duì)大家有幫助，同時(shí)也希望大家多多支持創(chuàng)新互聯(lián)，關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，更多相關(guān)知識(shí)等著你來學(xué)習(xí)!