c# - 如何在 asp.net core 的字段中添加 swagger 示例？

Question

基于 the Swagger documentation我必须能够为我的类字段添加一些示例，例如:

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

Answer 1

您可以启用 XML Comments然后使用 <example>元素来定义一个例子。这是使用 <example> 的示例:

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

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