SwashBuckle/Swagger隐藏了我的不可变属性

Question

对于通过[FromBody]传递到操作中的模型，我喜欢使其属性不可变public int SomeProperty{get；private set；} 。这样我就知道我的处理程序的输入没有被修改。

我遇到的问题是Swagger和Swashuckle完全忽略了这些字段来呈现参数有效负载的示例。我查看了从我们的API生成的swagger模式，发现所有提到的字段都有只读：true。

我想知道是否有办法配置Swashbuckler或Swagger，使其不忽略这些属性。或者，也许有某种方法可以使用Swashback扩展框架的某些部分将每个定义的readonly设置为false？

编辑：从swagger添加示例。json

在本例中，someProperty被标记为只读。我认为这就是为什么该属性没有显示在生成的POST参数示例中的原因。如果有一种方法可以让swagger gen不添加任何只读属性，我会接受的。

{
  "type": "object",
  "properties": {
    "someProperty": {
      "format": "int32",
      "type": "integer",
      "readOnly": true
    },
  }
}




Answer 1

所以我找到了一个解决方案。我创建了一个ISchemaFilter实现，它只是将每个属性上的readonly设置为false。我需要更多地考虑这意味着下游，所以我还不确定我是否喜欢这个解决方案。

public class IgnoreReadOnlySchemaFilter : ISchemaFilter
{
    public void Apply(Schema schema, SchemaFilterContext context)
    {
        schema.ReadOnly = false;
        if (schema.Properties != null)
        {
            foreach (var keyValuePair in schema.Properties)
            {
                keyValuePair.Value.ReadOnly = false;
            }
        }
    }
}