# swaggerFilter

**Repository Path**: long2023/swagger-filter

## Basic Information

- **Project Name**: swaggerFilter
- **Description**: 一些常用的swagger过滤器
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-30
- **Last Updated**: 2026-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swaggerFilter

#### 介绍
一些常用的swagger过滤器

#### 使用说明

```csharp
        // 添加Swagger服务
        services.AddSwaggerGen(options =>
        {
            options.SwaggerDoc("v1", new OpenApiInfo { Title = "WebAPI", Version = "v1" });
            options.DocInclusionPredicate((docName, description) => true);
            options.CustomSchemaIds(type => type.FullName);

            // 包含XML注释
            var rootNamespace = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}";
            rootNamespace = string.Join(".", rootNamespace.Split('.').Take(2));
            var xmlFiles = Directory.GetFiles(AppContext.BaseDirectory, $"{rootNamespace}*.xml", SearchOption.TopDirectoryOnly);
            foreach (var xmlFile in xmlFiles)
            {
                options.IncludeXmlComments(xmlFile);
            }

            // 注册枚举Schema过滤器，显示枚举值的文档注释
            options.SchemaFilter<SwaggerFilters.EnumSchemaFilter>();
        }
        );
```