如何为字符串列表指定示例值,以便Swashbuckle为OpenAPI生成?

时间:2019-07-24 14:17:38

标签: .net-core swagger openapi swashbuckle

我正在用文档注释注释所有模型对象,以便Swashbuckle可以在为每个方法生成的示例响应中显示有用的值。它适用于整数,字符串,枚举以及已应用类似文档的其他模型对象的列表:

public class MyModel {
    /// <example>1234</example>
    [JsonProperty("id")]
    public long Id { get; set; }

    /// <example>Jason Sadler</example>
    [JsonProperty("name")]
    public string Name { get; set; }

    // etc...
}

但是我不知道如何为字符串 list 提供示例值。例如,以下内容不会产生我想要的结果:

public class AnotherModel {
        /// <example>18005555555</example>
        [JsonProperty("phoneNumbers")]
        public IEnumerable<string> PhoneNumbers { get; set; }
        /// <example>["18005555555"]</example>
        [JsonProperty("otherNumbers")]
        public IEnumerable<string> OtherNumbers { get; set; }
}

对于此模型,我得到:

{
    "phoneNumbers": "18005555555",
    "otherNumbers": "[\"18005555555\"]"
}

想要要生成的是:

{
    "phoneNumbers": [
        "18005555555"
    ]
}

现在是否可以使用Swashbuckle进行此操作,还是应该提出功能请求?谢谢!

0 个答案:

没有答案