.Net Core 5.x Api開發筆記 -- Swagger設置Header(九)

来源:https://www.cnblogs.com/peterzhang123/archive/2022/06/18/16388451.html
-Advertisement-
Play Games

Swagger的基礎使用可以參考之前的文章:.Net Core 5.x Api開發筆記 -- Swagger(七) 這裡只記錄如何給Swagger添加Header,要達到的效果如下圖所示: 1,添加 HttpHeaderFilter 參數設置類 在項目中添加一個參數設置類,命名自定義就行,如下圖所示 ...


Swagger的基礎使用可以參考之前的文章:.Net Core 5.x Api開發筆記 -- Swagger(七)

這裡只記錄如何給Swagger添加Header,要達到的效果如下圖所示:

1,添加 HttpHeaderFilter 參數設置類

在項目中添加一個參數設置類,命名自定義就行,如下圖所示:

代碼如下:

 1 public class HttpHeaderFilter : IOperationFilter
 2 {
 3     /// <summary>
 4     /// 給Swagger添加Header頭部參數
 5     /// </summary>
 6     /// <param name="operation"></param>
 7     /// <param name="context"></param>
 8     public void Apply(OpenApiOperation operation, OperationFilterContext context)
 9     {
10         operation.Parameters = new List<OpenApiParameter>
11         {
12             new OpenApiParameter
13             {
14                 Name = "token",
15                 Description = "Token",
16                 In = ParameterLocation.Header,
17                 Required = false
18             },
19             new OpenApiParameter
20             {
21                 Name = "TermID",
22                 Description = "學期ID",
23                 In = ParameterLocation.Header,
24                 Required = false
25             },
26             new OpenApiParameter
27             {
28                 Name = "ContainerID",
29                 Description = "組織ID",
30                 In = ParameterLocation.Header,
31                 Required = false
32             }
33         };
34     }
35 }

參數說明:

Name:就是設置header的欄位屬性名稱,在同一個參數位置,名稱必須唯一,且大小寫敏感。

In:參數位置,常見有三個:

  • path:參數成為操作路徑(URL)的一部分,俗稱路徑參數。路徑參數的 required 欄位必需為 true
  • query:參數成為操作路徑(URL)查詢參數的一部分,俗稱查詢參數,如/users?id=123456
  • header:參數成為 HTTP 請求頭的一部分,俗稱請求頭參數。註意:請求頭是大小寫敏感的

Required:是否必需,預設值是 false

我們按照 In:參數位置的類型分別設置成 Header、Query、Path,看是什麼效果

 

2, 使用參數設置類 HttpHeaderFilter 

上邊的參數類已經創建好,下邊看下如何使用、使用很簡單,代碼如下(加紅標粗的代碼部分)

 1 public void ConfigureServices(IServiceCollection services)
 2 {
 3     services.AddControllers();
 4 
 5     //swagger
 6     services.AddSwaggerGen(options =>
 7     {
 8         options.SwaggerDoc("swaggerapi", new OpenApiInfo
 9         {
10             Version = "v1",
11             Title = "swaggerapi API文檔",
12             Description = "swaggerapi API的使用說明"
14         });
15 
16         // 為 Swagger JSON and UI設置xml文檔註釋路徑
17         // 獲取應用程式所在目錄(絕對路徑,不受工作目錄影響,建議採用此方法獲取路徑)
18         // 此方式適用於Windows/Linux 平臺
19         var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
20         var xmlPath = Path.Combine(basePath, "NetCore.Swagger.xml");
21         options.IncludeXmlComments(xmlPath);
22 
23         //添加自定義header授權參數
24         options.OperationFilter<HttpHeaderFilter>(Array.Empty<object>());
25     });
26 }

完畢!!!

作者:PeterZhang 出處:https://www.cnblogs.com/peterzhang123 本文版權歸作者和博客園共有,歡迎轉載,但必須給出原文鏈接,並保留此段聲明,否則保留追究法律責任的權利。
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 學生試卷中的題目有要提交截圖的,也有要提交文件的,為了方便學生考試,允許單獨交或者嵌入Word中提交,那麼事後如何整理學生的答案?單獨提交的比較方便,直接掃描文件名匹配名字後放入指定文件夾即可。但是嵌入到Word中的圖片和文件怎麼提取出來呢? 現有如下需求:提取出一個Word文檔中所有的圖片(png ...
  • 閱讀前註意 本文所有代碼貼出來的目的是幫助大家理解,並非是要引導大家跟寫,許多環境問題文件問題沒有詳細說明,代碼也並不全面,達不到跟做的效果。建議直接閱讀全文即可,我在最後會給出詳細代碼地址,對源代碼細節更感興趣的同學可以下載參考。 性能測試:使用日誌 在c++中進行性能測試是令人頭疼的問題,我們往 ...
  • 很久沒有寫博客了, 感覺沒有學到讓我自己眼前一亮的東西,所以還在摸索當中; 不過最近在複習spring相關的內容, 特別是迴圈依賴這塊, 查詢了很多的資料, 比較有收穫, 就分享一下吧! 分為上下兩篇博客, 第一篇是複習一下spring的整體流程, 第二篇說一下迴圈依賴 提前須知: 最好自己看過sp ...
  • 學習背景 公司同事讓我提供一個簡單的 rpc 介面,然後他坐在我旁邊看著我寫,寫的過程中他不斷打斷我,比如我在代碼換行時,如果游標不在下一行行首或者這行的行尾,我就會先移動游標到行尾,再點擊回車進行換行,他這時候就會說,為什麼你不用快捷鍵直接換行,最後變成了他手把手教我如何更高效的用快捷鍵編程,之前 ...
  • 首先一些Python字元串處理的簡易常用的用法。其他的以後用到再補充。 1.去掉重覆空格 s = "hello hello hello" s = ' '.join(s.split()) 2.去掉所有回車(或其他字元或字元串) s = "hello\nhello\nhello hello\n" pri ...
  • 前言 經常聽到有朋友說,學習編程是一件非常枯燥無味的事情。其實,大家有沒有認真想過,可能是我們的學習方法不對? 比方說,你有沒有想過,可以通過打游戲來學編程?今天我想跟大家分享幾個Python小游戲,教你如何通過邊打游戲邊學編程! 1、吃金幣 沒有人沒玩過吃金幣吧,但是用python來寫一個吃金幣小 ...
  • 一個挺著啤酒肚,身穿格子衫,髮際線嚴重後移的中年男子,手拿著保溫杯,胳膊夾著MacBook向你走來,看樣子是架構師級別。 面試開始,直入正題。 面試官: 小伙子,看到你的簡歷上面寫了項目中有對MySQL進行分庫分表,為什麼要進行分庫分表? 我: 不知道啊!誰知道老大咋想的,反正我來的時候就已經分好了 ...
  • XAML(Extensible ApplicationMarkup Language)即可擴展應用程式標記語言,是WPF技術中專門用於設計UI的語言,它在桌面開發及富媒體網路程式的開發中扮演了HTML+CSS+JavaScript的角色,是設計師與程式員之間溝通的樞紐。 ...
一周排行
    -Advertisement-
    Play Games
  • Timer是什麼 Timer 是一種用於創建定期粒度行為的機制。 與標準的 .NET System.Threading.Timer 類相似,Orleans 的 Timer 允許在一段時間後執行特定的操作,或者在特定的時間間隔內重覆執行操作。 它在分散式系統中具有重要作用,特別是在處理需要周期性執行的 ...
  • 前言 相信很多做WPF開發的小伙伴都遇到過表格類的需求,雖然現有的Grid控制項也能實現,但是使用起來的體驗感並不好,比如要實現一個Excel中的表格效果,估計你能想到的第一個方法就是套Border控制項,用這種方法你需要控制每個Border的邊框,並且在一堆Bordr中找到Grid.Row,Grid. ...
  • .NET C#程式啟動閃退,目錄導致的問題 這是第2次踩這個坑了,很小的編程細節,容易忽略,所以寫個博客,分享給大家。 1.第一次坑:是windows 系統把程式運行成服務,找不到配置文件,原因是以服務運行它的工作目錄是在C:\Windows\System32 2.本次坑:WPF桌面程式通過註冊表設 ...
  • 在分散式系統中,數據的持久化是至關重要的一環。 Orleans 7 引入了強大的持久化功能,使得在分散式環境下管理數據變得更加輕鬆和可靠。 本文將介紹什麼是 Orleans 7 的持久化,如何設置它以及相應的代碼示例。 什麼是 Orleans 7 的持久化? Orleans 7 的持久化是指將 Or ...
  • 前言 .NET Feature Management 是一個用於管理應用程式功能的庫,它可以幫助開發人員在應用程式中輕鬆地添加、移除和管理功能。使用 Feature Management,開發人員可以根據不同用戶、環境或其他條件來動態地控制應用程式中的功能。這使得開發人員可以更靈活地管理應用程式的功 ...
  • 在 WPF 應用程式中,拖放操作是實現用戶交互的重要組成部分。通過拖放操作,用戶可以輕鬆地將數據從一個位置移動到另一個位置,或者將控制項從一個容器移動到另一個容器。然而,WPF 中預設的拖放操作可能並不是那麼好用。為瞭解決這個問題,我們可以自定義一個 Panel 來實現更簡單的拖拽操作。 自定義 Pa ...
  • 在實際使用中,由於涉及到不同編程語言之間互相調用,導致C++ 中的OpenCV與C#中的OpenCvSharp 圖像數據在不同編程語言之間難以有效傳遞。在本文中我們將結合OpenCvSharp源碼實現原理,探究兩種數據之間的通信方式。 ...
  • 一、前言 這是一篇搭建許可權管理系統的系列文章。 隨著網路的發展,信息安全對應任何企業來說都越發的重要,而本系列文章將和大家一起一步一步搭建一個全新的許可權管理系統。 說明:由於搭建一個全新的項目過於繁瑣,所有作者將挑選核心代碼和核心思路進行分享。 二、技術選擇 三、開始設計 1、自主搭建vue前端和. ...
  • Csharper中的表達式樹 這節課來瞭解一下表示式樹是什麼? 在C#中,表達式樹是一種數據結構,它可以表示一些代碼塊,如Lambda表達式或查詢表達式。表達式樹使你能夠查看和操作數據,就像你可以查看和操作代碼一樣。它們通常用於創建動態查詢和解析表達式。 一、認識表達式樹 為什麼要這樣說?它和委托有 ...
  • 在使用Django等框架來操作MySQL時,實際上底層還是通過Python來操作的,首先需要安裝一個驅動程式,在Python3中,驅動程式有多種選擇,比如有pymysql以及mysqlclient等。使用pip命令安裝mysqlclient失敗應如何解決? 安裝的python版本說明 機器同時安裝了 ...