.NET Core 初次上手Swagger

来源:https://www.cnblogs.com/ya-jun/archive/2020/01/07/12162899.html
-Advertisement-
Play Games

安裝NuGet 程式包=》Swashbuckle.AspNetCore 在 Startup.ConfigureServices 方法里添加註冊生成器 1 //註冊Swagger生成器,定義一個和多個Swagger 文檔 2 services.AddSwaggerGen(c => 3 { 4 c.Sw ...


安裝NuGet 程式包=》Swashbuckle.AspNetCore

 

在  Startup.ConfigureServices  方法里添加註冊生成器

 1  //註冊Swagger生成器,定義一個和多個Swagger 文檔
 2  services.AddSwaggerGen(c =>
 3  {
 4     c.SwaggerDoc("v1", new Info() { Title = "測試版本", Version = "v1" });
 5 
 6     c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
 7     c.CustomSchemaIds(type => type.FullName); // 解決相同類名會報錯的問題
 8 
 9     c.IncludeXmlComments(Path.Combine(Directory.GetCurrentDirectory(), "SwaggerDemo.xml")); // 註釋要使用的 XML 文檔
10  });

 

 

 如果需要使用到在頁面顯示控制器的一些註釋,可選擇生成-輸出-XML文檔文件。

1591可免去一些沒有加註釋的一些警告。

註釋實例:

 

----

 

 

 

在  Startup.Configure  方法里添加中間件服務

 //啟用中間件服務生成Swagger作為JSON終結點
app.UseSwagger();

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

 

添加完後,可以自己建控制器了。

註意:控制器必須是API標識的控制器。

 

 

裡面的方法也必須帶有HTTP請求協議。

 

最後執行訪問=》/swagger/index.html

 

 

 

 

 學習來自依樂祝大佬的文章=》點擊進入超時空傳送


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

-Advertisement-
Play Games
更多相關文章
  • [TOC] FBV FBV是基於函數的視圖 CBV CBV是基於類的視圖 CBV基本寫法 ​ 朝login提交get請求會自動執行MyLogin裡面的get方法 ​ 而提交post請求也會自動執行MyLogin裡面的post方法 ​ 為什麼MyLogin針對不同的請求方法能夠自動執行對應的方法??? ...
  • 1.準備工作 安裝 Laravel laravel new laravel-swoole 本人使用 valet 進行開發,可以使用 laravel-swoole.test 進行訪問 2.引入 swoole 具體的 swoole 安裝請移步官網進行下載,編譯,安裝,這裡不多闡述了。 1. 在項目更目錄 ...
  • 模擬時鐘運行 一個clock類裡面有兩個display類,分別是時針分針,通過clock實現兩個時針(對象),分針(對象)的交互. 兩個對象互相不相關,通過比它們更高級的clock來實現交互 一個clock工程裡面一個clock包,裡邊兩個類,一個display類,一個clock類. package ...
  • 用 if 語句實現:將阿拉伯數字轉換為中文數字 public class IfToNum { public static void main(String[] args) { // 阿拉伯數字和中文數字的轉換 int n = 7; String str = n + "對應的中文大寫數字是"; if( ...
  • 在C#下使用TensorFlow.NET訓練自己的數據集 今天,我結合代碼來詳細介紹如何使用 SciSharp STACK 的 TensorFlow.NET 來訓練CNN模型,該模型主要實現 圖像的分類 ,可以直接移植該代碼在 CPU 或 GPU 下使用,並針對你們自己本地的圖像數據集進行訓練和推理 ...
  • 1、實體狀態 我們通過EF來對資料庫進行操作並持久化到資料庫,那麼EF必然通過EF上下文來維護實體的狀態,明確知道每一個狀態所對應的操作。也就是說EF通過上下文負責跟蹤實體的狀態。EF實體狀態存在命名空間System.Data.Entity下的EntityState枚舉中 1.1、Added Add ...
  • 在過去的2019年,承蒙各位的厚愛,WTM從零開始一年的時間在GitHub上收穫了將近1600星,nuget上的下載量累計超過10萬。 WTM所堅持的低碼開發,快速實現的理念受到了越來越多.netcore使用者的喜愛。 在2020年,我們將繼續迭代,推陳出新,為.netcore的開源生態做出更大的貢 ...
  • 微信公眾號: "Dotnet9" ,網站: "Dotnet9" , "問題或建議,請網站留言" ; "如果您覺得Dotnet9對您有幫助,歡迎贊賞" 。 Xamarin.Forms登錄系統 內容目錄 1. 實現效果 2. 業務場景 3. 編碼實現 4. 本文參考 5. 源碼下載 1.實現效果 彈出登 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...