c# - swagger の「Try it out」のリクエスト例を指定してください

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; }
    }

[Try it Out] (Userメッセージ本文でモデルを取得する POST 操作の場合) をクリックすると、既定値が表示されます。

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