日韩无码专区无码一级三级片|91人人爱网站中日韩无码电影|厨房大战丰满熟妇|AV高清无码在线免费观看|另类AV日韩少妇熟女|中文日本大黄一级黄色片|色情在线视频免费|亚洲成人特黄a片|黄片wwwav色图欧美|欧亚乱色一区二区三区

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

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
如何在ASP.NetCore中使用Swagger

本文轉載自微信公眾號「碼農(nóng)讀書」，作者碼農(nóng)讀書 。轉載本文請聯(lián)系碼農(nóng)讀書公眾號。

創(chuàng)新互聯(lián)公司是一家集網(wǎng)站建設,青陽企業(yè)網(wǎng)站建設,青陽品牌網(wǎng)站建設,網(wǎng)站定制,青陽網(wǎng)站建設報價,網(wǎng)絡營銷,網(wǎng)絡優(yōu)化,青陽網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè)，幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強企業(yè)競爭力?？沙浞譂M足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時我們時刻保持專業(yè)、時尚、前沿，時刻以成就客戶成長自我，堅持不斷學習、思考、沉淀、凈化自己，讓我們?yōu)楦嗟钠髽I(yè)打造出實用型網(wǎng)站。

大家在開發(fā)完 webapi 后，經(jīng)常為了方便接口雙方對接，需要將 webapi 接口文檔化，那有沒有什么快捷可交互的文檔呢?可以利用快捷工具 Swagger，它的可視化 UI 可輕松助你 API 文檔化的同時還方便測試 API。

Swashbuckle 就是一個用于生成 Swagger 文檔的開源工具包，這篇文章將會討論如何利用 Swashbuckle 來為你的 Restful API 生成可交互的文檔。

安裝 Swagger 中間件

要想利用 Swagger 文檔化，需要 nuget 引用 Swashbuckle.AspNetCore 包，還可以通過 Visual Studio 2019 的 NuGet package manager 可視化界面安裝 或者 通過 NuGet package manager 命令行工具輸入以下命令：

 
 
 
 
    
  
  
  
  
  1. dotnet add package Swashbuckle.AspNetCore 
    2.

配置 Swagger 中間件

為了配置 Swagger，在 Startup.ConfigureServices 方法中添加如下代碼，注意下面的 AddSwaggerGen 方法是用于給 API 文檔 添加一些元數(shù)據(jù)。

 
 
 
 
    
  
  
  
  
  1. services.AddSwaggerGen(c => 
    2. 
  
  
  
  
  2.            { 
    3. 
  
  
  
  
  3.                c.SwaggerDoc("v1", new Info 
    4. 
  
  
  
  
  4.                { 
    5. 
  
  
  
  
  5.                    Version = "v1", 
    6. 
  
  
  
  
  6.                    Title = "Swagger Demo", 
    7. 
  
  
  
  
  7.                    Description = "Swagger Demo for ValuesController", 
    8. 
  
  
  
  
  8.                    TermsOfService = "None", 
    9. 
  
  
  
  
  9.                    Contact = new Contact() { Name = "Joydip Kanjilal", 
    10. 
  
  
  
  
  10.                    Email = "joydipkanjilal@yahoo.com", 
    11. 
  
  
  
  
  11.                    Url = "www.google.com" } 
    12. 
  
  
  
  
  12.                }); 
    13. 
  
  
  
  
  13.            }); 
    14.

接下來就要啟動 Swagger了，在 Startup.Configure 方法下添加如下代碼：

 
 
 
 
    
  
  
  
  
  1. app.UseSwagger(); 
    2. 
  
  
  
  
  2.     app.UseSwaggerUI(c => 
    3. 
  
  
  
  
  3.     { 
    4. 
  
  
  
  
  4.         c.SwaggerEndpoint("/swagger/v1/swagger.json", "v1"); 
    5. 
  
  
  
  
  5.     }); 
    6.

為了完整性，下面是 Startup 中的所有代碼清單。

 
 
 
 
    
  
  
  
  
  1. using Microsoft.AspNetCore.Builder; 
    2. 
  
  
  
  
  2. using Microsoft.AspNetCore.Hosting; 
    3. 
  
  
  
  
  3. using Microsoft.AspNetCore.Mvc; 
    4. 
  
  
  
  
  4. using Microsoft.Extensions.Configuration; 
    5. 
  
  
  
  
  5. using Microsoft.Extensions.DependencyInjection; 
    6. 
  
  
  
  
  6. using Swashbuckle.AspNetCore.Swagger; 
    7. 
  
  
  
  
  7. namespace IDGSwaggerDemo 
    8. 
  
  
  
  
  8. { 
    9. 
  
  
  
  
  9.     public class Startup 
    10. 
  
  
  
  
  10.     { 
    11. 
  
  
  
  
  11.         public Startup(IConfiguration configuration) 
    12. 
  
  
  
  
  12.         { 
    13. 
  
  
  
  
  13.             Configuration = configuration; 
    14. 
  
  
  
  
  14.         } 
    15. 
  
  
  
  
  15.         public IConfiguration Configuration { get; } 
    16. 
  
  
  
  
  16.         public void ConfigureServices(IServiceCollection services) 
    17. 
  
  
  
  
  17.         { 
    18. 
  
  
  
  
  18.             services.AddMvc().SetCompatibilityVersion 
    19. 
  
  
  
  
  19.             (CompatibilityVersion.Version_2_2);    
    20. 
  
  
  
  
  20.             services.AddSwaggerGen(c => 
    21. 
  
  
  
  
  21.             { 
    22. 
  
  
  
  
  22.                 c.SwaggerDoc("v1", new Info 
    23. 
  
  
  
  
  23.                 { 
    24. 
  
  
  
  
  24.                     Version = "v1", 
    25. 
  
  
  
  
  25.                     Title = "Swagger Demo", 
    26. 
  
  
  
  
  26.                     Description = "Swagger Demo for ValuesController", 
    27. 
  
  
  
  
  27.                     TermsOfService = "None", 
    28. 
  
  
  
  
  28.                     Contact = new Contact() { Name = "Joydip Kanjilal", 
    29. 
  
  
  
  
  29.                     Email = "joydipkanjilal@yahoo.com", 
    30. 
  
  
  
  
  30.                     Url = "www.google.com" 
    31. 
  
  
  
  
  31.                 } 
    32. 
  
  
  
  
  32.                 }); 
    33. 
  
  
  
  
  33.             }); 
    34. 
  
  
  
  
  34.         } 
    35. 
  
  
  
  
  35.         public void Configure(IApplicationBuilder app, 
    36. 
  
  
  
  
  36.        IHostingEnvironment env) 
    37. 
  
  
  
  
  37.         { 
    38. 
  
  
  
  
  38.             if (env.IsDevelopment()) 
    39. 
  
  
  
  
  39.             { 
    40. 
  
  
  
  
  40.                 app.UseDeveloperExceptionPage(); 
    41. 
  
  
  
  
  41.             } 
    42. 
  
  
  
  
  42.             app.UseMvc(); 
    43. 
  
  
  
  
  43.             app.UseSwagger(); 
    44. 
  
  
  
  
  44.             app.UseSwaggerUI(c => 
    45. 
  
  
  
  
  45.             { 
    46. 
  
  
  
  
  46.                 c.SwaggerEndpoint("/swagger/v1/swagger.json", "v1"); 
    47. 
  
  
  
  
  47.             }); 
    48. 
  
  
  
  
  48.         } 
    49. 
  
  
  
  
  49.     } 
    50. 
  
  
  
  
  50. } 
    51.

瀏覽 Swagger UI

現(xiàn)在我們運行一下應用程序來瀏覽一下 Swagger UI 地址，可以看到 UI 界面如下圖所示，圖中不同的 Http 請求使用了不同的顏色進行標識，你甚至可以在UI上直接測試不同的 api 接口。

在 Action 方法上創(chuàng)建xml注解

到目前為止一切順利，在剛才生成的 swagger 文檔中，并沒有看到 5 個 api 接口的任何注解，這就不優(yōu)雅了，如果想要在 swagger 文檔上增加 xml 注解，簡單粗暴的做法可以直接在 Controller.Action 頂部寫上注解信息。

接下來在 ValuesController 下的每一個 Action 上都加上注解，下面就是修改后的 ValueController。

 
 
 
 
    
  
  
  
  
  1. [Route("api/[controller]")] 
    2. 
  
  
  
  
  2.     [ApiController] 
    3. 
  
  
  
  
  3.     public class ValuesController : ControllerBase 
    4. 
  
  
  
  
  4.     { 
    5. 
  
  
  
  
  5.         ///  
    6. 
  
  
  
  
  6.         /// Get action method without any argument 
    7. 
  
  
  
  
  7.         ///  
    8. 
  
  
  
  
  8.         ///  
    9. 
  
  
  
  
  9.         [HttpGet] 
    10. 
  
  
  
  
  10.         public ActionResult> Get() 
    11. 
  
  
  
  
  11.         { 
    12. 
  
  
  
  
  12.             return new string[] { "value1", "value2" }; 
    13. 
  
  
  
  
  13.         } 
    14. 
  
  
  
  
  14.  
    15. 
  
  
  
  
  15.         ///  
    16. 
  
  
  
  
  16.         /// Get action method that accepts an integer as an argument 
    17. 
  
  
  
  
  17.         ///  
    18. 
  
  
  
  
  18.         ///  
    19. 
  
  
  
  
  19.         ///  
    20. 
  
  
  
  
  20.         [HttpGet("{id}")] 
    21. 
  
  
  
  
  21.         public ActionResult Get(int id) 
    22. 
  
  
  
  
  22.         { 
    23. 
  
  
  
  
  23.             return "value"; 
    24. 
  
  
  
  
  24.         } 
    25. 
  
  
  
  
  25.  
    26. 
  
  
  
  
  26.         ///  
    27. 
  
  
  
  
  27.         /// Post action method to add data 
    28. 
  
  
  
  
  28.         ///  
    29. 
  
  
  
  
  29.         ///  
    30. 
  
  
  
  
  30.         [HttpPost] 
    31. 
  
  
  
  
  31.         public void Post([FromBody] string value) 
    32. 
  
  
  
  
  32.         { 
    33. 
  
  
  
  
  33.         } 
    34. 
  
  
  
  
  34.  
    35. 
  
  
  
  
  35.         ///  
    36. 
  
  
  
  
  36.         /// Put action method to modify data 
    37. 
  
  
  
  
  37.         ///  
    38. 
  
  
  
  
  38.         ///  
    39. 
  
  
  
  
  39.         ///  
    40. 
  
  
  
  
  40.         [HttpPut("{id}")] 
    41. 
  
  
  
  
  41.         public void Put(int id, [FromBody] string value) 
    42. 
  
  
  
  
  42.         { 
    43. 
  
  
  
  
  43.         } 
    44. 
  
  
  
  
  44.  
    45. 
  
  
  
  
  45.         ///  
    46. 
  
  
  
  
  46.         /// Delete action method 
    47. 
  
  
  
  
  47.         ///  
    48. 
  
  
  
  
  48.         ///  
    49. 
  
  
  
  
  49.         [HttpDelete("{id}")] 
    50. 
  
  
  
  
  50.         public void Delete(int id) 
    51. 
  
  
  
  
  51.         { 
    52. 
  
  
  
  
  52.         } 
    53. 
  
  
  
  
  53.     } 
    54.

打開 xml 注解

值得注意的是：Swagger 默認并不會顯示 XML 注解，需要手工打開它，那怎么做呢?右鍵 Project，選擇 Properties 后切換到 Build 頁面，然后選中 XML documentation file 項 并且指定好 xml 生成的位置，參考如下：

接下來還要在 ConfigureServices 方法下將生成xml 的路徑配置到 swagger 中，如下代碼所示：

 
 
 
 
    
  
  
  
  
  1. c.IncludeXmlComments(@"D:\Projects\IDG\IDGSwaggerDemo\IDGSwaggerDemo\IDGSwaggerDemo.xml"); 
    2.

這就是打開 Swagger 中的 xml 注解 所需的所有事情。

指定啟動url 到 Swagger UI

要想將啟動項目的url指到 SwaggerUI，右鍵 Project 并選擇 Properties，在 Debug 的 Lanuch browser 上指定 swagger 即可，如下圖所示：

再次運行程序可以發(fā)現(xiàn)默認頁就是 Swagger URL 了，如下圖所示：

從圖中可以看到，5個API方法后面都有相應的 xml 注解了。

Swashbuckle 是一個非常好的工具，可以簡單粗暴的給 API接口生成文檔，從文中也可以看出 Swashbuckle 的配置非常簡單，Swagger 還有一些更高級的功能，比如通過 CSS 來定制 Swagger UI，還可以根據(jù)API的版本生成不同的 Swagger 文檔，后續(xù)的文章還會跟大家介紹更多高級的功能。

譯文鏈接：https://www.infoworld.com/article/3400084/how-to-use-swagger-in-aspnet-core.html


分享題目：如何在ASP.NetCore中使用Swagger
轉載來于：http://www.5511xx.com/article/cceijcs.html