如何向asp.net core中的字段添加swagger示例？

Question

根据Swagger 文档，我必须能够为我的类字段添加一些示例，例如：

但我找不到任何方法将这些示例添加到我的课程中。

Answer 1

您可以启用XML 注释，然后使用该<example>元素定义示例。这是使用 的示例<example>：

public class CompanyValidationResponse
{
    /// <example>1234</example>
    public int CompanyId { get; set; }

    /// <example>Damage, Inc</example>
    public string CompanyName { get; set; }
}