servicestack - 在 ServiceStack 中传达必需/可选 DTO 属性的最佳方法是什么？

Question

我的 ServiceStack w/Swagger 实现在记录必需/可选属性方面遇到了问题。实现使用我的服务的客户端的开发人员喜欢 Swagger 文档，但是他们不知道哪些属性是必需的，哪些属性是可选的——除了在每次尝试获得有效请求时获得 400 响应。

以下面的例子为例:

public class UserProfile
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public UserAddress Address { get; set; }
}

public class UserAddress
{
    public string AddressLine1 { get; set; }
    public string AddressLine2 { get; set; }
    public string City { get; set; }
    public string State { get; set; }
    public string Zip { get; set; }
    public string Country { get; set; }
    public string PhoneNumber { get; set; }
}

如果这两种类型是我的 DTO 的一部分，Swagger 将清楚地显示这两种类型，但是我无法传达 FirstName、LastName 或任何 Address 属性是否需要。有没有办法在不必推出单独的规范文档的情况下实现这一点？

Answer 1

您可以使用 [ApiMember(IsRequired = false)]在 DTO 中的属性上添加属性，为 swagger ui 添加额外信息。

在 servicestack wiki 上有 swagger ui 将识别的属性列表