为swagger的 "试一试 "指定示例请求。

Question

有没有一种方法可以为swagger指定示例请求？甚至可能是多个？

这个 Try it out 按钮只显示通用值，如

{
    "firstName": "string",
    "lastName": "string"
}

对于

public class User
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

当你必须先编辑所有的值时，对大对象的使用就变得非常困难。我知道我可以使用Postman，我也是这样做的，但能够创建 多重 好看又有用的swagger的例子会非常好。

Answer 1

在 ASP.NET Core 3.1、Swagger OAS 3 和 Swashbuckle.AspNetCore 5.4.1 中，以下模型类 + XML 注释对我来说是可行的：-。

    /// <summary>
    /// A user.
    /// </summary>
    public class User
    {
        /// <summary>
        /// The user's first name.
        /// </summary>
        /// <example>Jane</example>
        public string FirstName { get; set; }

        /// <summary>
        /// The user's last name.
        /// </summary>
        /// <example>Austin</example>
        public string LastName { get; set; }
    }

现在，当我点击 "试一试"（对于一个POST操作，它需要一个 User 模型），我得到的默认值是：------。

{
    "firstName": "Jane",
    "lastName": "Austin"
}