C# .NetCore Swagger ISchemaFilter 补充业务元数据

目录步骤1定义ISchemaFilter步骤2注册ISchemaFilter步骤3使用和测试如果您喜欢此文章请收藏、点赞、评论谢谢祝您快乐每一天。在使用Swagger现在通常指的是OpenAPI规范与C#结合时特别是在使用Swashbuckle.AspNetCore库时我们可以通过ISchemaFilter接口来为Swagger生成的模型添加自定义的业务元数据。这对于增强API文档的可读性和实用性非常有帮助。步骤1定义ISchemaFilter首先你需要创建一个实现了ISchemaFilter接口的类。这个类将包含自定义的逻辑来修改或增强模型的Schema信息。using Swashbuckle.AspNetCore.SwaggerGen;using Microsoft.OpenApi.Models;using System.Collections.Generic;public class CustomSchemaFilter : ISchemaFilter{public void Apply(OpenApiSchema schema, SchemaFilterContext context){// 在这里添加你的自定义逻辑// 例如添加一个自定义的x-example属性schema.Example new OpenApiObject() { [summary] 这是一个示例值 };schema.Extensions.Add(x-custom-metadata, new OpenApiString(这是自定义元数据));}}步骤2注册ISchemaFilter在Startup.cs或Program.cs中你需要注册你的ISchemaFilter。这可以通过配置Swashbuckle来达成。在Startup.cs中ASP.NET Core 3.x及以前版本:public void ConfigureServices(IServiceCollection services){services.AddSwaggerGen(c {c.SchemaFilterCustomSchemaFilter(); // 注册你的过滤器});}在Program.cs中ASP.NET Core 5及以上版本:builder.Services.AddSwaggerGen(c {c.SchemaFilterCustomSchemaFilter(); // 注册你的过滤器});步骤3使用和测试一旦你注册了ISchemaFilter每当Swagger生成API文档时你的自定义逻辑就会被应用。你可以通过访问Swagger UI来查看生成的文档确认你的自定义元数据是否正确添加。示例添加业务元数据到特定模型或属性如果你的需求是只为特定的模型或属性添加元数据你可以在Apply方法中加入条件判断public void Apply(OpenApiSchema schema, SchemaFilterContext context){if (context.Type typeof(YourModelType)) // 替换为你的模型类型{schema.Extensions.Add(x-custom-metadata, new OpenApiString(这是特定模型的自定义元数据));}}通过这种方式你可以灵活地为不同的模型或属性添加特定的业务元数据从而丰富API文档的信息。如果您喜欢此文章请收藏、点赞、评论谢谢祝您快乐每一天。