.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
  • 一、引言:什麼是 JSON JSON (Java Script Object Notation) 是一種很常用的數據格式,它常常用在 web 應用程式中。它可以表示結構化的數據。 下麵是常見的 JSON 文件結構 { "name": "Kamishiro Rize", "age": "22", "o ...
  • 前言 大家好,我是蝸牛,在上一篇中,我們介紹了不同版本的HTTP區別和發展背景,這篇文章我們來聊聊HTTP的缺點,HTTP缺點大致總結有以下三點: 通信使用明文(不加密),內容可能會被竊聽。 不驗證通信方的身份,因此有可能遭遇偽裝(客戶端和服務端都有可能) 無法證明報文的完整性,有可能會被篡改。 其 ...
  • resultMap處理欄位和屬性的映射關係 如果欄位名與實體類中的屬性名不一致,該如何處理映射關係? 第一種方法:為查詢的欄位設置別名,和屬性名保持一致 下麵是實體類中的屬性名: private Integer empId; private String empName; private Integ ...
  • 大家在看到這篇文章前,為了有一個舒適的c++IDE,一定感受到了Dev-c++的廉價感,Clion功能的多餘,VS的臃腫。他們也有自己的優點,但糟點太多,令人十分難受。而VS Code,可以取長補短。下麵的配置內容,可以讓你在刷題時,享受絲滑的動畫,體會集成終端的方便,讓你覺得Coding不再枯燥。 ...
  • 給定一個不含重覆數字的數組 nums ,返回其 所有可能的全排列 。你可以 按任意順序 返回答案。 示例 1: 輸入:nums = [1,2,3] 輸出:[[1,2,3],[1,3,2],[2,1,3],[2,3,1],[3,1,2],[3,2,1]] 示例 2: 輸入:nums = [0,1] 輸 ...
  • 設計模式的目的 編寫軟體過程中,程式員面臨著來自 耦合性,內聚性以及可維護性,可擴展性,重用性,靈活性 等多方面的 挑戰,設計模式是為了讓程式(軟體),具有更好 代碼重用性 (即:相同功能的代碼,不用多次編寫) 可讀性 (即:編程規範性, 便於其他程式員的閱讀和理解) 可擴展性 (即:當需要增加新的 ...
  • 本文講解了決策樹的創鍵的過程,包括熵,信息增益的計算,還有決策樹的創建,以及使用matplotlib讓決策樹可視化的詳細過程 ...
  • ♠ use C++11 倍數 若 $a,b,k \in \mathbb N$,且 $a \times k=b$,那麼 $b$ 是 $a$ 的倍數,稱 $a$ 整除 $b$,記作 $a \mid b$。 $[1,n]\in \mathbb N$ 中 $x \in \mathbb N$ 的倍數有 $\l ...
  • LinkList可以定義指向List的指針 1.當函數參數為LinkList L時,意味著只改變或操作List的內容,而不需要改變L這個指針 如 Status GetElem(LinkList L,int i,ElemType) 2.當參數為LinkList &L時,意味著需要改變或操作L這個指針本 ...
  • Spring 5框架 一、Spring概念 1、Spring是輕量級的JavaEE框架 2、Spring可以解決企業應用開發的複雜性 3、Spring有兩個核心部分:IOC和AOP ​ 1)IOC:控制反轉,把創建對象過程交給Spring進行管理 ​ 2)AOP:面向切麵,不修改源代碼進行功能增強 ...