.NET 5中的System.Text.json字段序列化未在Swashbuckle API定义中显示

Question

我创造了一个重现这一点的要点。它在/api/test提供了一个HTTP Get方法，该方法返回test类型的对象，其中包含一个字段和一个属性。两者都是字符串。通过Postman调用这个API，将返回两者的正确值。查看/Swagger中的Swagger UI或/Swagger/v1/Swagger.json中的定义只显示该属性。

这种行为也适用于Swagger UI中的示例，这些示例只包含属性。

根据文档，Swagger生成器应该自动复制system.text.json的行为，system.text.json被显式配置为序列化字段（请参见第47行），因此我希望Swagger定义包括字段。

我尝试使用Swashbuckle生成返回这些序列化的API文档。这只适用于属性，而不适用于字段。

是否还有其他需要显式配置的东西才能起作用？

Answer 1

Swashbuckle似乎没有使用JSONSerializerOptions来生成文档。我发现的一个解决方法是手动处理类型：

public class FieldsSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        var fields = context.Type.GetFields();

        if (fields == null) return;
        if (fields.Length == 0) return;

        foreach (var field in fields)
        {
            schema.Properties[field.Name] = new OpenApiSchema
            {
                // this should be mapped to an OpenApiSchema type
                Type = field.FieldType.Name
            };
        }
    }
}

然后在您的startup.cs configureservices中：

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApplication1", Version = "v1" });
    c.SchemaFilter<FieldsSchemaFilter>();
});

逐步执行时，您将看到SchemaFilterContext(SchemaGenerator)中使用的JSONSerializerOptions。IncludeFields设置为true。仍然只有属性用于文档，所以我想像这样的过滤器是你最好的选择。