从Swagger看到真相！教你修改.NET ISchemaFilter过滤器默认参数值

用ISchemaFilter过滤器轻松修改Swagger参数默认值

在使用Swagger生成API文档时，您可能会发现某些参数的默认值与您的预期不符。别担心，我们可以轻松修改这些默认值。本文将引导您使用.NET中的ISchemaFilter过滤器来修改Swagger参数默认值。

了解ISchemaFilter过滤器

ISchemaFilter过滤器是一个接口，允许我们在Swagger生成文档之前对模型进行修改。通过实现此接口，我们可以自定义模型修改的行为。这包括修改参数的默认值。

创建过滤器

让我们创建一个名为MySchemaFilter的过滤器：

public class MySchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiOperation operation, Schema model, OperationFilterContext context)
    {
        // 根据类型修改默认值
        if (model.Type == "string")
        {
            model.Default = "Hello world!";
        }

        // 根据属性名修改默认值
        if (model.Properties.ContainsKey("Name"))
        {
            model.Properties["Name"].Default = "John Doe";
        }
    }
}

修改策略

在过滤器中，我们可以根据不同的策略修改默认值：

• 类型默认值： 根据参数类型设置默认值（如：字符串类型的默认值为"Hello world!"）
• 属性名默认值： 根据参数属性名设置默认值（如：Name属性的默认值为"John Doe"）

应用过滤器

在Startup.cs文件中注册过滤器：

public void ConfigureServices(IServiceCollection services)
{
    // 注册过滤器
    services.AddSwaggerGen(options =>
    {
        options.SchemaFilter<MySchemaFilter>();
    });
}

验证结果

重新生成Swagger文档。您会看到参数默认值已根据过滤器进行了修改。

好处

使用ISchemaFilter过滤器修改Swagger参数默认值的好处包括：

• 更好的文档： 文档中准确的参数默认值有助于API消费者了解API的行为。
• 一致性： 您可以确保参数默认值与您的应用程序逻辑一致。
• 灵活性： 您可以根据需要灵活地修改默认值。

常见问题解答

• 我可以在过滤器中做什么其他修改？ 您可以修改模型的各种属性，例如、示例和枚举。
• 我可以修改请求正文的默认值吗？ 是的，可以使用SchemaFilter过滤器修改任何模型，包括请求正文。
• 是否可以使用多个过滤器？ 是的，您可以注册多个过滤器，它们将在生成Swagger文档时按顺序应用。
• 过滤器对哪些类型的API有效？ 过滤器适用于所有通过SwaggerGen生成的API。
• 如何禁用过滤器？ 您可以在ConfigureServices方法中调用services.AddSwaggerGen(options => options.SchemaFilter())来禁用过滤器。