日本综合一区二区|亚洲中文天堂综合|日韩欧美自拍一区|男女精品天堂一区|欧美自拍第6页亚洲成人精品一区|亚洲黄色天堂一区二区成人|超碰91偷拍第一页|日韩av夜夜嗨中文字幕|久久蜜综合视频官网|精美人妻一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時間：8:30-17:00
你可能遇到了下面的問題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
你會.Net之Swagger基礎(chǔ)使用嗎?

本文轉(zhuǎn)載自微信公眾號「鵬祥」，作者AZRNG。轉(zhuǎn)載本文請聯(lián)系鵬祥公眾號。

介紹

Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。日常可以用于后端開發(fā)人員測試接口或者前后端聯(lián)調(diào)使用。從.net5開始，swagger已經(jīng)集成到vs2019編譯器中，可以通過勾對選項(xiàng)“啟用OpenAPI支持”顯示基本的swagger配置。

本文示例環(huán)境：vs2019、net5

1 基本使用

新建一個NetCore API項(xiàng)目，為了測試效果，我多創(chuàng)建幾個控制器

image.png

1.1 安裝組件

 
 
 
 
    
  
  
  
  
  1.  
    2.   
  
  
  
  2.     
    3.   
  
  
  
  3.   
    4.

1.2 注冊swagger服務(wù)

在ConfigureServices中

 
 
 
 
    
  
  
  
  
  1. public void ConfigureServices(IServiceCollection services) 
    2.   
  
  
  
  2. { 
    3.   
  
  
  
  3.     services.AddControllers(); 
    4.   
  
  
  
  4.     services.AddSwaggerGen(c => 
    5.   
  
  
  
  5.     { 
    6.   
  
  
  
  6.         c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApi", Version = "v1" }); 
    7.   
  
  
  
  7.     }); 
    8.   
  
  
  
  8. } 
    9.

注意：

//netcore3.0之前版本用法

c.SwaggerDoc("v1", new Info { Title = "WebApi", Version = "v1" });

1.3 使用Swagger

 
 
 
 
    
  
  
  
  
  1. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
    2.   
  
  
  
  2. { 
    3.   
  
  
  
  3.     if (env.IsDevelopment()) 
    4.   
  
  
  
  4.     { 
    5.   
  
  
  
  5.         app.UseDeveloperExceptionPage(); 
    6.   
  
  
  
  6.         app.UseSwagger(); 
    7.   
  
  
  
  7.         app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApi v1")); 
    8.   
  
  
  
  8.     } 
    9.   
  
  
  
  9.  
    10.   
  
  
  
  10.     app.UseRouting(); 
    11.   
  
  
  
  11.  
    12.   
  
  
  
  12.     app.UseAuthorization(); 
    13.   
  
  
  
  13.  
    14.   
  
  
  
  14.     app.UseEndpoints(endpoints => 
    15.   
  
  
  
  15.     { 
    16.   
  
  
  
  16.         endpoints.MapControllers(); 
    17.   
  
  
  
  17.     }); 
    18.   
  
  
  
  18. } 
    19.

該示例代碼配置的swagger只在Development環(huán)境下顯示，可以根據(jù)實(shí)際情況來修改

1.4 啟動

運(yùn)行項(xiàng)目，展示下面的效果

image.png

如果這是你寫的接口，這個時候你的其他同事去看，真的會一臉懵逼，你這寫的都是啥玩意，那么我們來給這加上注釋吧。

 
 
 
 
    
  
  
  
  
  1. ///  
    2.   
  
  
  
  2. /// 用戶控制器 
    3.   
  
  
  
  3. ///  
    4.   
  
  
  
  4. [Route("api/[controller]")] 
    5.   
  
  
  
  5. [ApiController] 
    6.   
  
  
  
  6. public class UserController : ControllerBase 
    7.   
  
  
  
  7. { 
    8.   
  
  
  
  8.     ///  
    9.   
  
  
  
  9.     ///查詢用戶列表 
    10.   
  
  
  
  10.     ///  
    11.   
  
  
  
  11.     ///  
    12.   
  
  
  
  12.     [HttpGet] 
    13.   
  
  
  
  13.     public IEnumerable Get() 
    14.   
  
  
  
  14.     { 
    15.   
  
  
  
  15.         return new string[] { "value1", "value2" }; 
    16.   
  
  
  
  16.     } 
    17.   
  
  
  
  17.  
    18.   
  
  
  
  18.     ///  
    19.   
  
  
  
  19.     /// 查詢用戶詳情 
    20.   
  
  
  
  20.     ///  
    21.   
  
  
  
  21.     ///  
    22.   
  
  
  
  22.     ///  
    23.   
  
  
  
  23.     [HttpGet("{id}")] 
    24.   
  
  
  
  24.     public string Get(int id) 
    25.   
  
  
  
  25.     { 
    26.   
  
  
  
  26.         return "value"; 
    27.   
  
  
  
  27.     } 
    28.   
  
  
  
  28.  
    29.   
  
  
  
  29.     ///  
    30.   
  
  
  
  30.     /// 刪除用戶 
    31.   
  
  
  
  31.     ///  
    32.   
  
  
  
  32.     ///  
    33.   
  
  
  
  33.     [HttpDelete("{id}")] 
    34.   
  
  
  
  34.     public void Delete(int id) 
    35.   
  
  
  
  35.     { 
    36.   
  
  
  
  36.     } 
    37.   
  
  
  
  37. } 
    38.

這樣子加了注釋還不行，swagger還讀取不到我們的注釋，我們還需要生成xml文檔并且讓swagger使用，選中項(xiàng)目右鍵屬性=>生成=>xml文檔文件

image.png

修改注入swagger配置

 
 
 
 
    
  
  
  
  
  1. services.AddSwaggerGen(c => 
    2.   
  
  
  
  2.    { 
    3.   
  
  
  
  3.        c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApi", Version = "v1" }); 
    4.   
  
  
  
  4.  
    5.   
  
  
  
  5.        // 使用反射獲取xml文件。并構(gòu)造出文件的路徑 
    6.   
  
  
  
  6.        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; 
    7.   
  
  
  
  7.        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); 
    8.   
  
  
  
  8.        // 啟用xml注釋.第二個參數(shù)啟用控制器的注釋，默認(rèn)為false. 
    9.   
  
  
  
  9.        c.IncludeXmlComments(xmlPath, true); 
    10.   
  
  
  
  10.    }); 
    11.

再次啟動項(xiàng)目查看界面

image.png

至此，基礎(chǔ)的配置swagger顯示注釋已經(jīng)實(shí)現(xiàn)了，那么如何調(diào)用我們接口那?

image.png

通過該界面，我們可以看到請求地址、請求方式、入?yún)㈩愋?、輸出參?shù)等。

注：

通過設(shè)置取消顯示警告：1591 ， 可以去除方法和類上面的xml注釋警告

如果實(shí)體類不在當(dāng)前程序集下，需要同樣方式配置實(shí)體類程序集的xml文檔到swagger配置

2. swagger傳遞JWT

jwt是一個基于json的、用于在網(wǎng)絡(luò)上聲明某種主張的令牌，通常是用三部分組成：頭信息，消息體，簽名。他是一種雙方之間傳遞安全信息的表述性聲明規(guī)范?？梢宰鰴?quán)限驗(yàn)證的工具，但是目的不是為了數(shù)據(jù)加密和保護(hù)。雖然看似像是加密的數(shù)據(jù)，但是它并沒有加密，不適合存儲機(jī)密信息。

如果我們接口是需要傳遞token才可以訪問，那么我們就需要對我們的swagger配置再進(jìn)行改造

 
 
 
 
    
  
  
  
  
  1. services.AddSwaggerGen(c => 
    2.   
  
  
  
  2.             { 
    3.   
  
  
  
  3.                 c.SwaggerDoc("v1", new OpenApiInfo {Title = "WebApi", Version = "v1"}); 
    4.   
  
  
  
  4.  
    5.   
  
  
  
  5.                 // 使用反射獲取xml文件。并構(gòu)造出文件的路徑 
    6.   
  
  
  
  6.                 var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; 
    7.   
  
  
  
  7.                 var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); 
    8.   
  
  
  
  8.                 // 啟用xml注釋.第二個參數(shù)啟用控制器的注釋，默認(rèn)為false. 
    9.   
  
  
  
  9.                 c.IncludeXmlComments(xmlPath, true); 
    10.   
  
  
  
  10.  
    11.   
  
  
  
  11.                 var security = new Dictionary> {{"Bearer", new string[] { }}}; 
    12.   
  
  
  
  12.                 c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme() 
    13.   
  
  
  
  13.                 { 
    14.   
  
  
  
  14.                     Description = "JWT授權(quán)(數(shù)據(jù)將在請求頭中進(jìn)行傳輸) 在下方輸入Bearer {token} 即可，注意兩者之間有空格", 
    15.   
  
  
  
  15.                     Name = "Authorization", //jwt默認(rèn)的參數(shù)名稱 
    16.   
  
  
  
  16.                     In = ParameterLocation.Header, //jwt默認(rèn)存放Authorization信息的位置(請求頭中) 
    17.   
  
  
  
  17.                     Type = SecuritySchemeType.ApiKey, 
    18.   
  
  
  
  18.                 }); 
    19.   
  
  
  
  19.                 c.AddSecurityRequirement(new OpenApiSecurityRequirement 
    20.   
  
  
  
  20.                 { 
    21.   
  
  
  
  21.                     { 
    22.   
  
  
  
  22.                         new OpenApiSecurityScheme 
    23.   
  
  
  
  23.                         { 
    24.   
  
  
  
  24.                             Reference = new OpenApiReference() 
    25.   
  
  
  
  25.                             { 
    26.   
  
  
  
  26.                                 Id = "Bearer", 
    27.   
  
  
  
  27.                                 Type = ReferenceType.SecurityScheme 
    28.   
  
  
  
  28.                             } 
    29.   
  
  
  
  29.                         }, 
    30.   
  
  
  
  30.                         Array.Empty() 
    31.   
  
  
  
  31.                     } 
    32.   
  
  
  
  32.                 }); 
    33.   
  
  
  
  33.             }); 
    34.

運(yùn)行，查看界面，發(fā)現(xiàn)界面有所不同

image.png

雖然我手上沒有token，但是我也沒有寫校驗(yàn)token的代碼，所以我們就暫且看為一個頭部傳遞的工具使用。jwt具體使用后續(xù)再講。

token傳遞方式就是在Headers增加 Authorization:Bearer {token} ，然后需要在程序中配置校驗(yàn)token，當(dāng)下我們只是模擬swagger在header中傳遞值。

在輸入框輸出：Bearer AABBCC

在Action中獲取我們傳輸?shù)臄?shù)據(jù)

 
 
 
 
    
  
  
  
  
  1. var token = HttpContext.Request.Headers["Authorization"]; 
    2.

image.png

3 參考文檔

https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-5.0


分享題目：你會.Net之Swagger基礎(chǔ)使用嗎?
鏈接分享：http://www.dlmjj.cn/article/dhdigjj.html