溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

在Web API程序中如何使用Swagger做接口文檔

發(fā)布時(shí)間：2021-11-30 16:54:44 來源：億速云 閱讀：167 作者：小新 欄目：編程語(yǔ)言

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

創(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è)試。

在Web API程序中如何使用Swagger做接口文檔

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

向AI問一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱：is@yisu.com進(jìn)行舉報(bào)，并提供相關(guān)證據(jù)，一經(jīng)查實(shí)，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手