asp.net core 一個中小型項目實戰的起手式——Swagger配置

来源:https://www.cnblogs.com/invoker-Fv/archive/2019/08/22/11393582.html

一、Swagger是什麼 Swagger 是一款RESTFUL介面的、基於YAML、JSON語言的文檔線上自動生成、代碼自動生成的工具。 二、如何在項目中加入Swagger Swagger安裝引用 右鍵Web項目依賴項>管理NuGet程式包>在搜索框輸入"Swashbuckle.AspNetCore ...


一、Swagger是什麼

Swagger 是一款RESTFUL介面的、基於YAML、JSON語言的文檔線上自動生成、代碼自動生成的工具。

 

二、如何在項目中加入Swagger

  • Swagger安裝引用

    右鍵Web項目依賴項>管理NuGet程式包>在搜索框輸入"Swashbuckle.AspNetCore",然後單擊安裝

      

    

  • 添加並配置Swagger中間件

    首先在Startup類中引入Swagger:

        using Swashbuckle.AspNetCore.Swagger;

    將 Swagger 生成器添加到ConfigureServices 方法中的服務集合中:

            //註冊Swagger生成器,定義一個和多個Swagger文檔
            services.AddSwaggerGen(p =>
            {
                p.SwaggerDoc("v1", new Info {Title = "數據管理器API文檔", Version = "V1"});
            });

 

    在Configure方法中,啟用中間件為生成的JSON文檔和SwaggerUI提供服務:

            //啟用中間件服務生成Swagger作為JSON終結點
            app.UseSwagger();
            //啟用中間件服務對swagger-ui,指定Swagger JSON終結點
            app.UseSwaggerUI(p =>
            {
                p.SwaggerEndpoint("/swagger/v1/swagger.json", "數據管理器API文檔 v1"); 
            });

    啟動應用,並跳轉到 http://localhost:<port>/swagger/v1/swagger.json 生成的描述終結點的文檔顯示如下json格式。

    

    可在 /swagger 找到 Swagger UI。 通過 Swagger UI 瀏覽 API文檔,如下所示。

 

  •  為介面方法提供註釋

  首先右鍵【解決方案資源管理器】中的項目,然後選【屬性】

  查看“生成”選項卡的【輸出】部分下的【XML 文檔文件】框

  啟用 XML 註釋後會為未記錄的公共類型和成員提供調試信息。如果出現很多警告信息  例如,以下消息指示違反警告代碼 1591。可以在進位顯示警告中加入警告代碼,這樣不會再在錯誤列表中顯示1591類型的警告了。

在Swagger註冊服務中增加:

            //註冊Swagger生成器,定義一個和多個Swagger文檔
            services.AddSwaggerGen(p =>
            {
                p.SwaggerDoc("v1", new Info {Title = "數據管理器API文檔", Version = "V1"});

                // 為 Swagger JSON and UI設置xml文檔註釋路徑
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程式所在絕對目錄
                var xmlPath = Path.Combine(basePath, "DataManager.Web.xml");//此處的文件名要對應到項目屬性中生成的xml文件名
                p.IncludeXmlComments(xmlPath);
            });

 

在控制器目錄下新增一個WebApi測試控制器,測試下效果

 

    [Route("api/[controller]/[action]")]
    [ApiController]
    public class SwaggerTestController : ControllerBase
    {
        /// <summary>
        /// 這是一個Swagger測試介面
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public IActionResult Test()
        {
            return new JsonResult(new {key = "Name", value = "test"});
        }
    }

訪問/swagger:

好了,今天的在ASP.NET Core WebApi使用Swagger生成api說明文檔的教程就到這裡了。希望能夠對大家學習在ASP.NET Core中使用Swagger生成api文檔有所幫助!


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

更多相關文章
  • 可能你是第一次聽說TomatoLog,沒關係,我可以從頭告訴你,通過瞭解番茄日誌,希望能幫助有需要的朋友,番茄日誌處理將大大降低你採集、分析、處理日誌的過程。 ...
  • 非空引用類型——C 8.0 原文地址:https://devblogs.microsoft.com/dotnet/try out nullable reference types/?utm_source=vs_developer_news&utm_medium=referral 該新增的特性最關鍵的 ...
  • 源碼: ...
  • 源碼: ...
  • 簡介 Socean.RPC是一個.Net下的高性能RPC框架,框架以高性能、高穩定性為目標,底層基於socket,代碼簡潔,總代碼量大約在2000行,無第三方庫引用,框架性能較高,在雙核i5筆記本上可達10w+每秒的處理量,支持10000長連接消息發送(每秒發10個短消息),均穩定運行,記憶體和cpu ...
  • 在項目的bin\debug\netcoreapp${Version}下麵能夠找到這個${AppName}.runtimeconfig.json文件,簡單來說,它就是用來定義應用程式所用的共用框架(.Net Core App)以及運行時選項 的一個文件。 一個簡單的例子 1、用來決定以哪個版本的.ne ...
  • 導出至Excel是非常常見,我們可以用很多類庫,例如Aspose、NOPI、Interop,在這裡我們使用微軟自家的工具。我的WPF綁定的ObservableCollection<T>集合。 該方法還不止這麼多,還涉及到了1-27 = A-Z 的適配,如以下方法。 最後我們獲取數據給方法,下麵是設計 ...
  • 本文主要參照https://www.bilibili.com/video/av42364337/?p=4 英文幫助文檔:https://identityserver4.readthedocs.io/en/latest/ 中文幫助文檔:http://www.identityserver.com.cn ...
一周排行
  • 該方式是直接對屏幕進行截圖操作UserControl chartContainPanel = new UserControl();Graphics graph = chartContainPanel.CreateGraphics();Size s = chartContainPanel.Size;B... ...
  • dotnetcore3.1 WPF 中使用依賴註入 Intro 在 ASP.NET Core 中預設就已經集成了依賴註入,最近把 "DbTool" 遷移到了 WPF dotnetcore 3.1, 在 WPF 中我們也希望能夠使用依賴註入,下麵來介紹一下如何在 WPF dotnetcore3.1 中 ...
  • 原來的C 程式都有Main的,現在用vs新建一個Wpf項目,啟動似乎變成App.xmal,前期項目中為了獲取啟動參數,很是折騰了一番: 1.先是修改App.xaml,添加StartUp事件 2.然後編輯Application_Startup,判斷e.Args數組 總感覺跟又臭又長的裹腳布一樣,不爽。 ...
  • 冒泡排序原理:(升序)通過當前位置數和後一個位置數進行比較 如果當前數比後一個數大 則交換位置, 完成後 比較基數的位置變成下一個數。直到數組末尾,當程式運行完第一遍 最大的數已經排序到最後一個位置了。次數可以減少迴圈數不用管最後一個數 降序排序同理 不過是把比較方式變成判斷當前數是否小於下一個數 ...
  • 一、前言 這方面的資料很多,重覆的寫沒必要,但是最近一直在學習身份驗證和授權相關東東,為了成體系還是寫一篇,主要是從概念上理解identity系統。 參考:https://www.cnblogs.com/r01cn/p/5179506.html 二、概述 幾乎所有系統都包含用戶、角色、許可權、登錄、註 ...
  • 首先我們使用最簡單的模板案例,裡面有一個Counter計數器,你可以在創建模板中找到。 首先需要設置運行調試方式為IIS Express。這意味著,MAC可能不能使用調試。 然後開啟運行而不調試(Ctrl+F5) 按Shift + Alt + D,會出現一個新的頁面。 如果你想用Chrome調試,復 ...
  • 實體映射時,遇到複雜類型,可選擇下述方法處理: NotMapped,跳過映射 在複雜類型上聲明 [Owned],但僅限該複雜類型是全部由簡單值類型組成的 自定義序列化方法 示例: IPInfo使用了owned,對IPEndPoint使用自定義序列化,對VersionInfo使用JSON序列化 @@@... ...
  • .NET Core 3 Web Api Cors fetch 一直 307 Temporary Redirect 繼上一篇 ".net core 3 web api jwt 一直 401" 為添加 所述的坑後, 本次為添加 ,又踩坑了。 自從 .NET Core 2.2 之後,CORS跨域配置代碼發 ...
  • 在前一章已經學習過WPF動畫的第一條規則——每個動畫依賴於一個依賴項屬性。然而,還有另一個限制。為了實現屬性的動態化(換句話說,使用基於時間的方式改變屬性的值),需要有支持相應數據類型的動畫類。例如,Button.Width屬性使用雙精度數據類型。為實現屬性的動態化,需要使用DoubleAnimat ...
  • WPF dotnet core 3.1 基於 `Microsoft.Extensions.Localization` 實現基本的多語言支持 ...
x