c# - API ドキュメントのカスタム追加情報

Question

Web API ヘルプページの追加情報については、こちらをお読みください。データ注釈は、実際には文書化のための追加情報を提供します。しかし、データ注釈なしで追加情報を提供する方法があることを知りたいですか?

はいの場合、どのように？

そうでない場合は、追加情報をデータ注釈でオーバーライドする方法があります。

[Required]

追加情報に必須と書いてありますが、「この項目は必須です」とか表示したい場合はどうすればいいですか？

ありがとう

編集画像を参照可能であれば、データ注釈なしでその追加情報を更新したいと思います。

score 3 · Accepted Answer

たとえば、次Required Attribute のように編集できます。ModelDescriptionGenerator.cs
Areas>HelpPage>ModelDescriptions>ModelDescriptionGenerator.cs

    [Required(ErrorMessage ="Must pass")]
    public string Name { get; set; }

私は得た: 追加情報: 合格しなければならない

交換：

 { typeof(RequiredAttribute), a => "Required" }

と：

{ typeof(RequiredAttribute), a => {
            RequiredAttribute b =(RequiredAttribute)a;
            return (b.ErrorMessage);
        }

見る

score 3 · Accepted Answer

したがって、注釈を使用すると、要件をさらに指定できます。つまり、次のモデルがある場合です。

public class MyModel {

    [Required(ErrorMessage = "You seriously need a name here bro")]
    public string Name{ get; set; }

}

次のように、ASP.Net ページに検証メッセージを自動的に表示できます。

@model string
@Html.TextBoxFor(m => m)
@Html.ValidationMessageFor(model => model, "", new { @class = "text-danger"})

したがって、基本的には、 Required属性が有効になったときに ASP.Net によって入力される検証メッセージ用のフィールドを追加します。

score 2 · Accepted Answer

（データ注釈を使用して）カスタムの追加情報を提供したい場合は、@ Pedro G. Diasの答えが解決策ですが、データ注釈を使用せずに追加情報を提供したい場合は、それが不可能であるか、いくつかを使用する必要があることを恐れていますあなたの質問について@DynamicVariableがコメントしたように、そうするための代替手順。

PS。ドキュメントプロジェクトをデバッグして確認したところ、追加情報が実際にはデータ注釈によって提供されていることがわかりました。

c# - API ドキュメントのカスタム追加情報

3 に答える 3

Related

Reference