使用构造函数在 swagger 中设置属性

Question

我正在构建一个API并使用swagger测试endpoint。我有一个产品：

public string ProductName { get; set; }
.
.
.
public Price Price { get; set; }

在这个DTO中，我想使用在我的代码中使用的Price类。价格类如下所示：

public class Price
{
    public Price(decimal amount, string currency)
    {
        Amount = amount;
        Currency = currency;
    }

    public decimal Amount { get; private set; }
    public string Currency { get; private set; }
}

但是由于私有设置器在Price类中使用，我无法使用swagger设置这些值（它在这些上具有readonly属性）。我真的很喜欢这种拥有私有设置器并使用构造函数设置值的方法，顺便说一句，这是公共的。有没有办法我可以使用swagger为Price类设置值，并且仍然在属性上使用私有设置器？

Answer 1

添加此架构筛选器对我有效。

public class AddReadOnlyPropertiesFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (schema?.Properties?.Count > 0)
            schema.Properties.Values.SingleOrDefault(v => v.ReadOnly = false);
    }
}

Answer 2

更新：我最初的回答（见下文）是这是不可能的，但是，这实际上取决于您项目中使用的序列化库。

例如，Newtonsoft的 Json.NET 允许您通过构造函数设置一些类的属性（注意：如果您的类带有多个构造函数，请应用JsonConuctorAttribute）：

public class Price
{
    [JsonConstructor]
    public Price(decimal amount, string currency)
    {
        Amount = amount;
        Currency = currency;
    }

    public decimal Amount { get; private set; }
    public string Currency { get; private set; }
}

原答案

不，这是不可能的。因为如果您将属性保持私有，并仅通过构造函数初始化它们，反序列化器将不知道这些属性应如何映射到后端（DTO）模型。

因此，在使用DTO时，通常不会看到人们通过构造函数初始化。

此外，由于您在整个代码中都使用了Price类，因此您将“域模型”与“视图模型”（=用于与客户端通信的模型）混合使用，这是一种务实的方法，但在DDD等样式中并不提倡。在这种情况下，如果您希望在属性上使用不同的属性或不同的访问修饰符，您应该创建一个专用的PriceDTO，它映射到您的价格实体，但具有公共setter和getter。

另一种选择是将向客户端发送数据（通过GET）的endpoint使用的模型与接收数据作为有效负载以创建或更新事物（通过POST/PATCH/PUT）的endpoint使用的模型分开。然而，这通常是以冗余为代价的，因为这两种情况下的模型通常非常相似。