指定示例请求招摇的“尝试一下”

时间:2019-07-26 08:25:44

标签: c# json http-post swagger asp.net-core-webapi

有没有办法指定招摇的示例请求?也许甚至多个?

Try it out按钮仅显示如下通用值:

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

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

当必须先编辑所有值时,使用大型对象变得非常困难。我知道我可以使用邮递员,我也可以,但是能够用挥舞的手来创建多个漂亮且有用的示例。

1 个答案:

答案 0 :(得分: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; }
    }

现在,当我单击“试用”(对于在邮件正文中采用User模型的POST操作)时,将获得默认值:-

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