c# - 本文パラメーターの説明フィールドを生成する

Question

だから私はこの問題を解決しようとたくさんグーグルで検索してきましたが、何も見つからないようです。参照用の写真を参照してください。ただし、本文パラメーターの [説明] フィールドに入力しようとしています。これを行う最善の方法は何ですか？

Answer 1

説明属性を追加できます。

[Description("Get the data from our service. It will requires a key.")]
public ActionResult GetData(string key)
{
  //Do something here...
  return Json(new{Success=true, Data = data});
}

またはパラメータの場合

public ActionResult GetData([Description("A valid key should be formated as xxx-xxx-xx")]string key)
{
  //Do something here...
  return Json(new{Success=true, Data = data});
}

から: http://millionbonus.bitbucket.org/mvc.apiexplorer/

Answer 2

うまくいけば、これはこれに出くわした他の誰かを助けることができます. 最初に、このリンクに従って、ApiExplorer の XML ドキュメントを有効にします。追加したいことを有効にした後

/// <summary>Description</summary>

コントローラー名の上 (別の行を追加することで、xml にパラメーター名も追加できます<param name="model">A Test Model</param>)

次に、モデルに移動し、モデル内の各パラメーターに対して、次のように要約タグを再度追加します。

public class TestModel()
{
/// <summary>This is your IdNumber you received earlier</summary>
public string IdNumber {get;set;}
}