激情久久久_欧美视频区_成人av免费_不卡视频一二三区_欧美精品在欧美一区二区少妇_欧美一区二区三区的

服務器之家：專注于服務器技術及軟件下載分享
分類導航

PHP教程|ASP.NET教程|Java教程|ASP教程|編程技術|正則表達式|C/C++|IOS|C#|Swift|Android|VB|R語言|JavaScript|易語言|vb.net|

服務器之家 - 編程語言 - ASP.NET教程 - .NET Core利用swagger進行API接口文檔管理的方法詳解

.NET Core利用swagger進行API接口文檔管理的方法詳解

2020-05-24 14:50OMango ASP.NET教程

這篇文章主要給大家介紹了關于.NET Core利用swagger進行API接口文檔管理的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧。

一、問題背景

隨著技術的發展，現在的開發模式已經更多的轉向了前后端分離的模式，在前后端開發的過程中，聯系的方式也變成了API接口，但是目前項目中對于API的管理很多時候還是通過手工編寫文檔，每次的需求變更只要涉及到接口的變更，文檔都需要進行額外的維護，如果有哪個小伙伴忘記維護，很多時候就會造成一連續的問題，那如何可以更方便的解決API的溝通問題？Swagger給我們提供了一個方式，由于目前主要我是投入在.NET Core項目的開發中，所以以.NET Core作為示例

二、什么是Swagger

Swagger可以從不同的代碼中，根據注釋生成API信息，swagger擁有強大的社區，并且對于各種語言都支持良好，有很多的工具可以通過swagger生成的文件生成API文檔

三、.NET Core中使用

.NET Core中使用首先要用nuget引用Swashbuckle.AspNetCore，在startup.cs中加入如下代碼

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
 services.AddMvc();
 services.AddSwaggerGen(c =>
 {
  c.SwaggerDoc("v1", new Info { csharp" id="highlighter_699906">
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
namespace WebApplication2.Controllers
{
 /// <summary>
 /// 測試信息
 /// </summary>
 [Route("api/[controller]/[action]")]
 public class ValuesController : Controller
 {
  /// <summary>
  /// 獲取所有信息
  /// </summary>
  /// <returns></returns>
  [HttpGet]
  public IEnumerable<string> Get()
  {
   return new string[] { "value1", "value2" };
  }
  /// <summary>
  /// 根據ID獲取信息
  /// </summary>
  /// <param name="id"></param>
  /// <returns></returns>
  // GET api/values/5
  [HttpGet("{id}")]
  public string Get(int id)
  {
   return "value";
  }
  /// <summary>
  /// POST了一個數據信息
  /// </summary>
  /// <param name="value"></param>
  // POST api/values
  [HttpPost]
  public void Post([FromBody]string value)
  {
  }
  /// <summary>
  /// 根據ID put 數據
  /// </summary>
  /// <param name="id"></param>
  /// <param name="value"></param>
  // PUT api/values/5
  [HttpPut("{id}")]
  public void Put(int id, [FromBody]string value)
  {
  }
  /// <summary>
  /// 根據ID刪除數據
  /// </summary>
  /// <param name="id"></param>
  // DELETE api/values/5
  [HttpDelete("{id}")]
  public void Delete(int id)
  {
  }
  /// <summary>
  /// 復雜數據操作
  /// </summary>
  /// <param name="id"></param>
  // DELETE api/values/5
  [HttpPost]
  public namevalue test(namevalue _info)
  {
   return _info;
  }
 }
 
 public class namevalue
 {
  /// <summary>
  /// name的信息
  /// </summary>
  public String name { get; set; }
  /// <summary>
  /// value的信息
  /// </summary>
  public String value { get; set; }
 }
}

接下來我們還需要在生成中勾上XML生成文檔，如圖所示

.NET Core利用swagger進行API接口文檔管理的方法詳解

接下去我們可以運行起來了，調試，瀏覽器中輸入http://localhost:50510/swagger/，這里端口啥的根據實際情況來，運行效果如下圖所示：

.NET Core利用swagger進行API接口文檔管理的方法詳解

可以看到swagger將方法上的注釋以及實體的注釋都抓出來了，并且顯示在swaggerui，整體一目了然，并且可以通過try it按鈕進行簡單的調試，但是在具體項目中，可能存在需要將某些客戶端信息通過header帶到服務中，例如token信息，用戶信息等（我們項目中就需要header中帶上token傳遞到后端），那針對于這種情況要如何實現呢？可以看下面的做法

?
    • <dl id="16611"><pre id="16611"><tfoot id="16611"></tfoot></pre></dl>
      • <table id="16611"><th id="16611"></th></table>
      1. 
				
					
        
						
							
        
								1
        
							
        
								2
        
							
        
								3
        
							
        
								4
        
							
        
								5
        
							
        
								6
        
							
        
								7
        
							
        
								8
        
							
        
								9
        
							
        
								10
        
							
        
								11
        
							
        
								12
        
							
        
								13
        
							
        
								14
        
						        		
						
							
        
								
        
									// This method gets called by the runtime. Use this method to add services to the container.
        
								
        
									  public void ConfigureServices(IServiceCollection services)
        
								
        
									  {
        
								
        
									   services.AddMvc();
        
								
        
									   services.AddSwaggerGen(c =>
        
								
        
									   {
        
								
        
									    c.SwaggerDoc("v1", new Info { csharp" id="highlighter_96448">
			
        
				?
        
			
        
				
					
        
						
							
        
								1
        
							
        
								2
        
							
        
								3
        
							
        
								4
        
							
        
								5
        
							
        
								6
        
							
        
								7
        
							
        
								8
        
							
        
								9
        
							
        
								10
        
							
        
								11
        
							
        
								12
        
							
        
								13
        
							
        
								14
        
							
        
								15
        
							
        
								16
        
							
        
								17
        
							
        
								18
        
						        		
						
							
        
								
        
									public class AddAuthTokenHeaderParameter : IOperationFilter
        
								
        
									{
        
								
        
									 public void Apply(Operation operation, OperationFilterContext context)
        
								
        
									 {
        
								
        
									  if (operation.Parameters == null)
        
								
        
									  {
        
								
        
									   operation.Parameters = new List<IParameter>();
        
								
        
									  }
        
								
        
									  operation.Parameters.Add(new NonBodyParameter()
        
								
        
									  {
        
								
        
									   Name = "token",
        
								
        
									   In = "header",
        
								
        
									   Type = "string",
        
								
        
									   Description = "token認證信息",
        
								
        
									   Required = true
        
								
        
									  });
        
								
        
									 }
        
								
        
									}
        
							
        
						        		
					
        
				        
			
        
		
        
	
        


        
	我們在ConfigureServices添加了OperationFilter<AddAuthTokenHeaderParameter>() ，通過這種方式我們可以在swagger中顯示token的header，并且進行調試（如圖所示），AddAuthTokenHeaderParameter 的apply的屬性context中帶了controller以及action的各種信息，可以配合實際情況使用
        

        
	.NET Core利用swagger進行API接口文檔管理的方法詳解
        

        
	 四、與其他API管理工具結合
        

        
	swagger強大的功能以及社區的力量，目前很多的API管理工具都支持YApi，目前我們使用的是由去哪兒開源的YApi，從圖中可以看到YApi支持導入swagger生成的JSON文件，除該工具 之外DOClever（開源）也是一個不錯的API管理工具，也支持Swagger文件導入（具體工具用法，大家可以去看他們的官網）
        

        
	.NET Core利用swagger進行API接口文檔管理的方法詳解
        

        
	源碼下載：demo地址
        

        
	五、總結
        

        
	Swagger是一個很好的工具，并且在前后端分離開發越來越流行的情況下，在后續的開發過程中，我覺得會扮演著越來越重要的作用，目前我們公司小的項目已經準備開始使用swagger+yapi進行API的管理方式，而這篇文章也是這段時間抽空整理API管理的結果，希望可以幫助到大家，這里可能有很多不足的地方，歡迎大家拍磚，也希望可以跟大家一起進步
        

        
	以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對服務器之家的支持。
        

        
	原文鏈接：http://www.cnblogs.com/OMango/p/8460092.html
        

			
		    
        
			
			
        
			
        
				 
			
        
		
		
        
			
			
        
				
			
        
		
        
		
        
			
        
				
        延伸 · 閱讀
        
			
        
			
		
        
		
        
		
        
		
		
        
			
        
				精彩推薦
			
        
		
        
		
        
			
		
        
	
	 


        

        
 

        





主站蜘蛛池模板：
欧美一级黄色录像片
|
国产青草视频在线观看视频
|
欧美在线 | 亚洲
|
成人午夜视频免费在线观看
|
成人短视频在线播放
|
亚洲精华液久久含羞草
|
在线1区
|
一本大道av
|
免费观看黄色一级视频
|
hdbbwsexvideo
|
亚洲最新无码中文字幕久久
|
99pron|
午夜精品福利视频
|
深夜免费视频
|
中国久久久
|
爱性久久久久久久
|
韩国美女一区
|
国产美女的小嫩bbb图片
|
免费一级在线
|
欧美一级黄色录像片
|
中文字幕在线观看视频一区
|
国产永久免费观看
|
欧美精品
|
亚洲男人的天堂在线视频
|
久久久久久久爱
|
黄网站免费在线看
|
麻豆视频网
|
黄色影院一级片
|
国产午夜精品视频免费不卡69堂
|
欧美一区二区三区免费观看
|
狠狠干91
|
国产亲子伦在线观看
|
国产精品一区二区视频
|
亚洲一区二区三区精品在线观看
|
成人在线视频网
|
极品销魂一区二区三区
|
男男啪羞羞视频网站
|
久久亚洲激情
|
暖暖免费观看高清完整版电影
|
国产精品av久久久久久网址
|
一级国产精品一级国产精品片
|