SwaggerUI ASP.Net WebAPI2

来源:http://www.cnblogs.com/Rexcnblog/archive/2017/02/20/6420425.html
-Advertisement-
Play Games

目前在用ASP.NET的 WebAPI2來做後臺介面開發,在與前臺做測試的時候,總是需要發送一個demo給他,但是這樣很麻煩的,他還有可能記不住。 然後就想到SwaggerUI 生成測試文檔。 話不多說,來看看它的具體用法吧! 第一步: 在VS2015(後者是你自己的工具里)打開程式包管理控制台輸入 ...


目前在用ASP.NET的 WebAPI2來做後臺介面開發,在與前臺做測試的時候,總是需要發送一個demo給他,但是這樣很麻煩的,他還有可能記不住。

然後就想到SwaggerUI 生成測試文檔。

話不多說,來看看它的具體用法吧!

第一步:

在VS2015(後者是你自己的工具里)打開程式包管理控制台輸入:

Install-Package Swashbuckle

等待安裝,完成後會發現,在App_Start文件夾下會多出來一個配置文件SwaggerConfig.cs

第二步:

打開這個文件然後找到Register()方法里的c.IncludeXmlComments(),增加一個參數,也就是說改成c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

然後在跟Register方法平級的地方增加一個方法

protected static string GetXmlCommentsPath(string name)
        {
            return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
        }

然後配置文件到此結束,

第三步:

繼續做對於項目的配置

右鍵項目->屬性->生成->勾選(XML文檔文件)->點擊保存文件即可。

第四步:

輸入訪問路徑

http://localhost:15416/swagger/ui/index

這裡邊關於主機和埠需要替換成寄幾的。

最後成果

這裡做個備註,發現每個請求後邊都會有註釋,而且點開以後也有註釋,這個就是你在你的介面中的註釋,它可以直接拿過來顯示的。

/// <summary>
/// 發送手機驗證碼
/// </summary>
/// <param name="mobile">手機號</param>

參考:http://www.cnblogs.com/fangwei0505/p/6398382.html

同時放上SpringMVC的Demo:http://blog.csdn.net/u011499992/article/details/53455144


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 假設在win(192.168.0.101)上安裝了xmanager,想接收來自linux(192.168.100.16)的圖形界面。 1.在win端打開Xmanager - Passive 2.在linux上設置DISPLAY環境變數 export DISPLAY=192.168.0.101:0.0... ...
  • 1、AWK內部代碼編寫(為了更好的理解) 2、去掉回車,加上其他部分 目的:要查看當前目錄中大於4kB的文件的,並將其大小相加求出總大小。 3、查看當前目錄大於4Kb的文件 4、AWK常用參數 -F(表示已什麼為分隔符) 目的:查看nologin用戶 grep查看以nologin結尾的行,AWK查詢 ...
  • misc子系統在Linux中是一個非常簡單的子系統,但是其清晰的框架結構非常適合用來研究設備識別模型。本文從misc子系統的使用出發,通過瞭解其機制來總結一套的設備識別的驅動框架,即使用 使用同一個驅動,向上提供多個設備文件介面,向下控制多個(相應的)設備 ,這就需要該驅動可以根據不同的設備文件來控 ...
  • public class XmlUtility { /// <summary> /// 反序列化.接收2個參數:xmlFilePath(需要反序列化的XML文件的絕對路徑),type(反序列化XML為哪種對象類型) /// </summary> /// <param name="xmlFilePat ...
  • 下麵是視頻教程的提綱: PPT版本的提綱下載 本節源碼下載 XAF框架開發教程 快速實現企業級信息系統開發的利器 XAF簡介 ´ 開發公司:www.devexpress.com,老牌控制項公司 ´ 從2006年發佈第一個XAF版本,至今11年 ´ 基於Microsoft.Net Framework ´ ...
  • 什麼是NuGet? [NuGet][](讀作New Get)是用於微軟.NET開發平臺的軟體包管理器,是一個Visual Studio的擴展。在使用Visual Studio開發基於.NET Framework的應用時,NuGet能夠令你在項目中添加、移除和更新引用的工作變得更加快捷方便。 通過Nu ...
  • 一.認識Redis1. Redis 是一個高性能的key-value資料庫。 2. 它支持存儲的value類型相對更多,包括string(字元串)、list(鏈表)、set(集合)、zset(sorted set --有序集合)和hash(哈希類型)。 3.周期性的把更新的數據寫入磁碟或者把修改操作 ...
  • 寒假在家無聊,找了一本還不錯的電子書來學習, 一是複習了以前最初學的一些基本類, 二是學一些那時候老師沒有教的東西, 看的書是pdf的所以下麵全部都是手打出來的,有什麼錯誤在所難免。 其實一個寒假只看了這麼一點還是很懶惰的。 放上來以後自己好查。以後空閑了還可以看看。 快捷鍵 Ctrl + Ente ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...