8

ASP.Net Web Api ヘルプ ページは、パラメーターが要求 Uri または本文にあるかどうかを自動的に判断するようです。QueryString パラメーターであるオプション パラメーターを文書化するにはどうすればよいですか?

たとえば、次のようなRESTful URLがある場合があります

[GET] api/Books?relatedToBookId=xx

ここで、「relatedToBookId」はオプションの queryString パラメータです。

通常、FromUri または FromBody であるパラメーターは、次のようにコメントに入れられます。

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

1 に答える 1

10

次のようにすると、オプションのクエリ文字列パラメーター情報が HelpPage に表示されます。

以下のコード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)

また、このパラメーターがオプションであることについて言及したい場合は、次のことができます。

  • インストールされたファイル (Areas/HelpPage/Views/Help/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;

于 2013-07-16T22:28:53.953 に答える