ASP.NET Core 3.0 WebApi中使用Swagger生成API文檔簡介

来源:https://www.cnblogs.com/taotaozhuanyong/archive/2019/09/28/11602820.html
-Advertisement-
Play Games

參考地址，官網：https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio 與https://www.ji ...


參考地址，官網：https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio

與https://www.jianshu.com/p/349e130e40d5

當一個WebApi完成之後，書寫API文檔是一件非常頭疼的事，因為不僅要寫得清楚，能讓調用介面的人看懂，又是非常耗時耗力的一件事。在之前的一篇隨筆中（https://www.cnblogs.com/taotaozhuanyong/p/11567017.html），記載.Net Framework中WebApi生成文檔的時候，通過訪問指定的路徑，就可以獲取到Api文檔。在.NET Core中又怎麼生成API文檔呢？使用Swagger。

為什麼使用Swagger作為REST APIs文檔成功工具呢？

　　1、Swagger可以生產一個具有互動性的API控制台，開發者可以用來學習和嘗試API。

　　2、Swagger可以生產客戶端SDK代碼用於各種不同的平臺上的實現。

　　3、Swagger文件可以在許多不同的平臺上從代碼註釋中自動生成。

　　4、Swagger有一個強大的社區，裡面有許多強悍的貢獻者。

Swagger簡單介紹

Swagger官網：https://swagger.io/irc/

 

Swagger Codegen：通過Codegen可將描述文件生成html和cwiki形式的介面文檔，同時也能生成多種語言的服務端和客戶端的代碼。可以在後面的Swagger Editor中線上生成。

Swagger UI：提供了一個可視化的UI頁面 展示描述文件。介面的調用方、測試、項目經理等都可以在該頁面中對相關介面進行查閱和做一些簡單的介面請求。該項目支持線上導入文件和本地部署UI項目。

Swagger Editor：類似於markendown編輯器的編輯Swagger描述文件的編輯器，改編輯器支持實時預覽描述文件的更新效果。也提供了線上編輯器和本地部署編輯器兩種方式。

Swagger Inspector：感覺和postman差不多，是一個可以對介面進行測試的線上版的postman。比在Swagger UI裡面做介面請求，會返回更多的信息，也會保存你請求的實際請求參數等數據。

Swagger Hub：繼承了上面所有項目的各個功能，你可以以項目和版本為單位，將你的描述文件上傳到Swagger Hub中。在Swagger Hub中跨域完成上面項目的所有工作，需要註冊賬號，分免費版和收費版。

下麵介紹如何在ASP.NET Core中使用Swagger生成API說明文檔

.NET Core3.0已經出來了，那我們就基於.NET Core3.0新建一個WebApi項目吧。

這裡為了掩飾Swagger的使用，就不創建空項目了，選擇ASP.NET Core 3.0

 

 

創建完成會顯示這個樣子，會給我們預設增加一個WeatherForecastController

 

 

 [ApiController]
 [Route("[controller]")]
 public class WeatherForecastController : ControllerBase
 {
     private static readonly string[] Summaries = new[]
     {
         "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
     };

     private readonly ILogger<WeatherForecastController> _logger;

     public WeatherForecastController(ILogger<WeatherForecastController> logger)
     {
         _logger = logger;
     }

     [HttpGet]
     public IEnumerable<WeatherForecast> Get()
     {
         var rng = new Random();
         return Enumerable.Range(1, 5).Select(index => new WeatherForecast
         {
             Date = DateTime.Now.AddDays(index),
             TemperatureC = rng.Next(-20, 55),
             Summary = Summaries[rng.Next(Summaries.Length)]
         })
         .ToArray();
     }
 }
View Code

當我們這個時候運行的時候，會出現404的錯誤（不知道你們有沒有遇到，反正我是遇到了），不要著急，我們做以下修改就行。

首先在Controller中將[Route("[controller]")]====》[Route("api/WeatherForecast")]

再在launchSettings.json中做修改。

 

 這樣，我們再訪問一下，就成功了。

 

 回歸今天的主題。如何使用Swagger。

首先，安裝依賴包 Swashbuckle.AspNetCore，選擇最新版本的。使用Nuget或者控制台都可以。.Net Core2.0下，這樣是沒問題的。但是在.Net Core3.0下，最好使用PowerShell進行安裝。

Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc2

 

 添加並配置Swagger中間件

引入命名空間

using Swashbuckle.AspNetCore.Swagger;

在 Startup 類中，導入以下命名空間來使用 OpenApiInfo 類：

using Microsoft.OpenApi.Models;

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

在.Net  Core3.0之前：

//註冊Swagger生成器，定義一個和多個Swagger 文檔
services.AddSwaggerGen(c =>
{
     c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});

但是在.Net Core 3.0中，要這樣寫

 services.AddSwaggerGen(c =>
 {
     c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
 });

一個是new Info(),一個是new OpenApiInfo()。這也是為什麼最好使用Powershell去安裝引用。否則會報錯：

TypeLoadException: Could not load type 'Microsoft.AspNetCore.Mvc.MvcJsonOptions' from assembly 'Microsoft.AspNetCore.Mvc.Formatters.Json, Version=3.0.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60'.

在Configure方法中，啟動中間件為生成的JSON文檔和Swagger UI提供服務：

//啟用中間件服務生成Swagger作為JSON終結點
app.UseSwagger();
//啟用中間件服務對swagger-ui，指定Swagger JSON終結點
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

啟動應用，並導航到http://localhost:<post>/swagger/v1/swagger.sjon。生成的描述終結點的文檔顯示如下：

 

 

 可在 http://localhost:<port>/swagger 找到 Swagger UI。 通過 Swagger UI 瀏覽 API文檔，如下所示。

 

 

 要在應用的根 (http://localhost:<port>/) 處提供 Swagger UI，請將 RoutePrefix 屬性設置為空字元串：

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    c.RoutePrefix = string.Empty;
});

自定義和擴展：

Swagger提供了為對象模型進行歸檔和自定義UI以匹配你的主題的選項。

API信息說明

傳遞給AddSwagger方法的配置操作會添加註入作者、許可證和說明信息：在.Net Core3.0是這樣寫的，與之前寫法稍微有點區別。請註意下。

 services.AddSwaggerGen(c =>
 {
     c.SwaggerDoc("v1", new OpenApiInfo
     {
         Version = "v1",
         Title = "Bingle API",
         Description = "一個簡單的ASP.NET Core Web API",
         TermsOfService = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
         Contact = new OpenApiContact
         {
             Name = "bingle",
             Email = string.Empty,
             Url = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
         },
         License = new OpenApiLicense
         {
             Name = "許可證",
             Url = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
         }
     });
 });

訪問地址http://localhost:<port>/swagger，就看到上述添加的信息

 

 

上述完成之後，我們發現，介面並沒有註釋，那麼我們怎麼來添加註釋呢？

XML註釋

在Visual Studio中，在“解決方案資源管理器”中右鍵單擊該項目，然後選擇“編輯 <project_name>.csproj” 。手動將突出顯示的行添加到 .csproj 文件 ：

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

啟用 XML 註釋，為未記錄的公共類型和成員提供調試信息。 警告消息指示未記錄的類型和成員。 例如，以下消息指示違反警告代碼 1591：

warning CS1591: Missing XML comment for publicly visible type or member 'TodoController.GetAll()'

要在項目範圍內取消警告，請定義要在項目文件中忽略的以分號分隔的警告代碼列表。 將警告代碼追加到 $(NoWarn); 

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

services.AddSwaggerGen修改為如下：

註意：

　　1、對於Linux或者非Windows操作系統，文件名和路徑區分大小寫。例如“MyWebApiUseSwagger.xml”文件在Windows上有效，但在CentOS上無效

　　2、獲取應用程式路徑，建議採用Path.GetDirectoryName(typeof(Program).Assembly.Location)這種方式或者·AppContext.BaseDirectory這樣來獲取

 services.AddSwaggerGen(c =>
 {
     c.SwaggerDoc("v1", new OpenApiInfo
     {
         Version = "v1",
         Title = "Bingle API",
         Description = "一個簡單的ASP.NET Core Web API",
         TermsOfService = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
         Contact = new OpenApiContact
         {
             Name = "bingle",
             Email = string.Empty,
             Url = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
         },
         License = new OpenApiLicense
         {
             Name = "許可證",
             Url = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
         }
     });
     //為 Swagger JSON and UI設置xml文檔註釋路徑
     var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
     var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
     c.IncludeXmlComments(xmlPath);
 });

 

經過上面的配置，介面中的方法就有註釋了：

 

 通過上面的操作就可以總結出來，Swagger UI顯示上述註釋代碼 <summary>元素的內部文本作為api大的註釋！當然你還可以將 remarks 元素添加到 Get 操作方法文檔。 它可以補充 <summary> 元素中指定的信息，並提供更可靠的 Swagger UI。 <remarks> 元素內容可包含文本、JSON 或 XML。 代碼如下：

 /// <summary>
 /// 這是一個帶參數的get請求
 /// </summary>
 /// <remarks>
 /// 例子:
 /// Get api/Values/1
 /// </remarks>
 /// <param name="id">主鍵</param>
 /// <returns>測試字元串</returns>  
 [HttpGet("{id}")]
 public ActionResult<string> Get(int id)
 {
     return $"你請求的id是{id}";
 }

可以看到如下效果：

 

 描述響應類型

使用WebApi的開發人員最關心的問題是返回的內容，特別是響應類型和錯誤代碼。在XML註釋和數據中表示相應類型的錯誤代碼。Get 操作成功後返回HTTP 201狀態碼。發佈的請求正文為NULL，將返回HTTP 400狀態代碼。如果Swagger UI中沒有提供合適的文檔，那麼使用者會缺少對這些預期的結果的瞭解。

在以下的實例中，通過突出的行解決此問題：

 /// <summary>
 /// 這是一個帶參數的get請求
 /// </summary>
 /// <remarks>
 /// 例子:
 /// Get api/Values/1
 /// </remarks>
 /// <param name="id">主鍵</param>
 /// <returns>測試字元串</returns> 
 /// <response code="201">返回value字元串</response>
 /// <response code="400">如果id為空</response>  
 // GET api/values/2
 [HttpGet("{id}")]
 [ProducesResponseType(201)]
 [ProducesResponseType(400)]
 public ActionResult<string> Get(int id)
 {
     return $"你請求的id是{id}";
 }

以下是看到的效果

 

如何使用Swagger UI進行測試？

點擊Try it out

 

 輸入參數，再點擊Excute：

 

 得到的響應結果：

 

 

以上便是在.Net Core 3.0 WebApi中使用Swagger的基本介紹。以及在.Net Core3.0下如何創建WebApi，在使用Swagger在和以前有什麼區別的的介紹。希望能夠幫助到大家。


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

-Advertisement-
Play Games
更多相關文章
  • 淺談nginx簡介和應用場景
    簡介 nginx是一款輕量級的web伺服器，它是由俄羅斯的程式設計師伊戈爾·西索夫所開發。 nginx相比於Tomcat性能十分優秀，能夠支撐5w的併發連接（而Tomcat只能支撐200-400），並且nginx對CPU和記憶體的消耗十分的低，運行十分穩定。 nginx的作用非常多，但我們通常把它作為 ...
  • Java 基礎篇之編程基礎
    基本數據類型 java 是強類型語言，在 java 中存儲的數據都是有類型的，而且必須在編譯時就確定其類型。 基本數據類型變數存儲的是數據本身，而引用類型變數存的是數據的空間地址。 基本類型轉換 自動類型轉換 把一個表數範圍小的數值或變數直接賦給另一個表數範圍大的變數時，系統將會進行自動類型轉換，否 ...
  • FLask中藍圖(用於分文件)
    一,不使用藍圖，自己分文件 目錄結構 app.py init.py user.py order.py 註意點:只有是包的時候才能from.然後import 相對路徑進行導入 缺點 容易發生迴圈導入問題 二.使用藍圖之中小型系統 "詳見代碼點擊可以下載" 目錄結構： __init_.py manage ...
  • 【Flask系列】開發一個簡單的Flask程式
    知識點 1. 初始化 ：每一個flask程式都必須創建一個程式實例，遵循WSGI(Web Server Gateway interface)協議,把請求 flask Obj; 創建實例： Flask 類的構造函數只有一個必須指定的參數，即程式主模塊或包的名字。在大多數程式中，Python 的 __n ...
  • Flask框架整個流程源碼解讀
    Flask框架整個流程源碼解讀 一.總的流程 運行Flask其本質是運行Flask對象中的\_\_call\_\_,而 本質調用wsgi_app的方法 二.具體流程 1.ctx = self.request_context(environ) environ 請求相關的，ctx現在是包含request ...
  • c#通過Redis實現輕量級消息組件
    最近在開發一個輕量級ASP.NET MVC開發框架，需要加入日誌記錄，郵件發送，簡訊發送等功能，為了保持模塊的獨立性，所以需要通過消息通信的方式進行處理，為了保持框架在部署，使用，二次開發過程中的簡易便捷性，所以沒有選擇傳統的MQ，而是基於Redis的訂閱發佈實現一個系統內部消息組件，話不多說，上碼 ...
  • （七十八）c#Winform自定義控制項-倒影組件
    前提 入行已經7,8年了，一直想做一套漂亮點的自定義控制項，於是就有了本系列文章。 GitHub：https://github.com/kwwwvagaa/NetWinformControl 碼雲：https://gitee.com/kwwwvagaa/net_winform_custom_contr ...
  • （七十七）c#Winform自定義控制項-採樣控制項
    前提 入行已經7,8年了，一直想做一套漂亮點的自定義控制項，於是就有了本系列文章。 GitHub：https://github.com/kwwwvagaa/NetWinformControl 碼雲：https://gitee.com/kwwwvagaa/net_winform_custom_contr ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類