swagger+enum+注释如何实现？

1、添加DocumentFilter


GlobalConfiguration.Configuration
	.EnableSwagger(c =>
	{
	c.DocumentFilter();
	})

2、 {project-webapi}/swagger下新增类SwaggerAddEnumDescriptions

using System;
using System.Web.Http.Description;
using Swashbuckle.Swagger;
using System.Collections.Generic;

namespace WebWeizhanWeixinGateway.Swagger
{
    /// 
    ///  swagger enum 支持
    /// 
    public class SwaggerAddEnumDescriptions : IDocumentFilter
    {
        /// 
        /// Apply
        /// 
        /// swaggerDoc
        /// schemaRegistry
        /// apiExplorer
        public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
        {
            // add enum descriptions to result models
            foreach (KeyValuePair schemaDictionaryItem in swaggerDoc.definitions)
            {
                Schema schema = schemaDictionaryItem.Value;
                foreach (KeyValuePair propertyDictionaryItem in schema.properties)
                {
                    Schema property = propertyDictionaryItem.Value;
                    IList propertyEnums = property.@enum;
                    if (propertyEnums != null && propertyEnums.Count > 0)
                    {
                        property.description += DescribeEnum(propertyEnums);
                    }
                }
            }

            // add enum descriptions to input parameters
            if (swaggerDoc.paths.Count > 0)
            {
                foreach (PathItem pathItem in swaggerDoc.paths.Values)
                {
                    DescribeEnumParameters(pathItem.parameters);

                    // head, patch, options, delete left out
                    List possibleParameterisedOperations = new List { pathItem.get, pathItem.post, pathItem.put };
                    possibleParameterisedOperations.FindAll(x => x != null).ForEach(x => DescribeEnumParameters(x.parameters));
                }
            }
        }

        private void DescribeEnumParameters(IList parameters)
        {
            if (parameters != null)
            {
                foreach (Parameter param in parameters)
                {
                    IList paramEnums = param.@enum;
                    if (paramEnums != null && paramEnums.Count > 0)
                    {
                        param.description += DescribeEnum(paramEnums);
                    }
                }
            }
        }

        private string DescribeEnum(IList enums)
        {
            List enumDescriptions = new List();
            foreach (object enumOption in enums)
            {
                enumDescriptions.Add(string.Format("{0} = {1}", (int)enumOption, Enum.GetName(enumOption.GetType(), enumOption)));
            }
            return string.Join(", ", enumDescriptions.ToArray());
        }

    }
}



						  
					  
						
							


						

							
							
			C							
						



						

						
						


						

						
					
					

					
					

						
相关

						

				
						
			

																
								

										
C# 十六进制八进制前缀或后缀

									
									

								 

        

								

							
							

																
								

										
C#中的Attribute（特性）的使用

									
									

								 

        

								

							
							

																
								

										
c#小灶——9.算术运算符

									
									

								 

        

								

							
							

																
								

										
c#小灶——4.注释和代码规范

									
									

								 

        

								

							
							

																
								

										
c#小灶——3.输出语句

									
									

								 

        

								

							
							

																
								

										
【Luogu3414】SAC#1 - 组合数

									
									

								 

        

								

							
							

																
								

										
[C#] 使用递归将多条路径生成树

									
									

								 

        

								

							
							

																
								

										
C#封装定时执行任务类

									
									

								 

        

								

							
							

																
								

										
【C#进阶系列】30 学习总结

									
									

								 

        

								

							
							

																
								

										
【C#进阶系列】10 属性

									
									

								 

        

								

							
							

																
								

										
【C#进阶系列】18 特性Attribute

									
									

								 

        

								

							
							

																
								

										
C# string 加号与StringBuilder .netCore3.1与 .netCore5.0速度测试

									
									

								 

        

								

							
							
            
            
            
                                    
           
  			
						

					

					
				

				

														
					
					

					
									

					
									   
标签

										

										
    
										

									

										
										

									

					

					
				


			
		
		
		
			


						





	

	
一品网 冀ICP备14022925号-6