.net怎么使用Swagger-有解無憂

目錄導航

一、安裝
二、配置
三、呼叫
四、錯誤記錄

一、安裝

新建一個沒有身份驗證的mvc專案 - SwaggerMvc5Demo，然后添加一個名為Remote（自定義）且包含基礎讀寫（不想手寫）的ApiController

開源地址：https://github.com/domaindrivendev/Swashbuckle 使用以下方法來添加 Swashbuckle：

從“程式包管理器控制臺”視窗：Install-Package Swashbuckle -Version 5.6.0
從“管理 NuGet 程式包”對話框中：

右鍵單擊“解決方案資源管理器” > “管理 NuGet 包”中的專案
將“包源”設定為“nuget.org”
在搜索框中輸入“Swashbuckle”
從“瀏覽”選項卡中選擇“Swashbuckle”包，然后單擊“安裝”

二、配置

1.專案屬性->勾選生成xml檔案檔案

2.添加導航鏈接在_Layout.cshtml檔案中添加代碼 <li>@Html.ActionLink("Swagger Help", "", "Swagger", new { area = "" }, null)</li> 3.修改SwaggerConfig.cs檔案安裝完成后，在檔案夾App_Start自動生成一個組態檔 swagger.config，這里可以做多版本控制，定義擴展功能，自定義顯示ui的樣式腳本，可以配置過濾、權限等，例如：（1）為介面添加xml注釋 string path = string.Format("{0}/bin/SwaggerMvc5Demo.XML", System.AppDomain.CurrentDomain.BaseDirectory); c.IncludeXmlComments(path); 使用前

使用后

（2）使用特性 [Obsolete] 在config中開啟 c.IgnoreObsoleteProperties();

三、呼叫

1.直接呼叫只要輸入引數id，即可呼叫，非常方便

2.AutoRest AutoRest (https://github.com/Azure/AutoRest), 簡單來說，就是一個EXE工具，可以根據Swagger的結構生成服務的客戶端，這個客戶端可以讓你像呼叫本地方法一樣呼叫服務，方法內部包裝了Http請求，詳細教程請看 https://www.cnblogs.com/Leo_wl/p/5982882.html 擴展：ABP集成swagger http://www.cnblogs.com/wer-ltm/p/5776024.html

四、錯誤記錄

swagger出現問題：not supported by swagger 2.0

一個controller中只能有一個HttpGet請求，多了就會報錯，建議減少多載方法，將其他Get方法分開

如果在swagger.config中加上c.ResolveConflictingActions(apiDescriptions => apiDescriptions.FirstOrDefault());則會只顯示第一個get方法

原文：https://blog.csdn.net/jin80506/article/details/77737470

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/16061.html

標籤：ASP.NET

上一篇：OWIN,Katana,identity整體概述

下一篇：多場景搶紅包業務引發.NETCore下使用配接器模式實作業務介面分離