ASP.NET WebApiヘルプページでオプションのQueryStringパラメータを文書化するにはどうすればよいですか？

Question

ASP.Net Web Apiのヘルプページは、パラメータがリクエストUriまたはBodyにあるかどうかを自動的に判断します。 QueryStringパラメータであるオプションパラメータを文書化するにはどうすればよいですか？私が持っている例えば

は、このような "relatedToBookIdは" オプションのqueryStringパラメータである

[GET] api/Books?relatedToBookId=xx 

としてRESTfulなURLを持っていることがあります。通常FromUriまたはFromBodyあるパラメータはあなたが次のことを行うことができますし、あなたのオプションのクエリ文字列パラメータ情報がHelpPageに表示さでしょう

<param name="variableName">blah blah</param> 

Answer 1

ようなコメントに入れている

。

relatedToBookIdは、Query Stringからのオプションのパラメータです。このパラメータはオプションであることについて言及したい場合にも

/// <summary> 
    /// Gets list of books 
    /// </summary> 
    /// <param name="relatedToBookId">Your description here</param> 
    /// <returns>returns list of books</returns> 
    public IEnumerable<Book> GetBooks(int? relatedToBookId = null) 

、あなたは次の操作を行うことができますインストールされたファイルへ

• ゴー（エリア/ HelpPage /ビュー/ヘルプ/ DisplayTemplatesを/ Parameters.cshtml）

• アップデート以下にcase ApiParameterSource.FromUriに関連した条件：

  case ApiParameterSource.FromUri: <p>Define this parameter in the request <b>URI</b>.</p> if(parameter.ParameterDescriptor.IsOptional) { <p>This parameter is <b>optional</b>.</p> } break;