Jak dokumentować opcjonalny parametr QueryString na stronach pomocy ASP.NET WebApi?

Question

Strony pomocy ASP.Net Web Api wydają się automatycznie określać, czy parametr znajduje się w żądaniu URI lub treści. Jak mogę udokumentować parametry opcji, które są parametrami QueryString?

Na przykład mam może mieć relaksującego URL taki jak

[GET] api/Books?relatedToBookId=xx 

gdzie „relatedToBookId” jest opcjonalny parametr queryString.

Normalnie parametry, które są FromUri lub FromBody są umieszczane w komentarzach jak

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

Answer 1

Można wykonać następujące czynności a opcjonalny parametr ciąg kwerendy informacji byłoby pokazać się w Helppage.

W poniższym kodzie relatedToBookId jest opcjonalnym parametrem pochodzącym z łańcucha zapytania.

/// <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) 

Ponadto, jeśli chcesz wspomnieć o ten parametr jest opcjonalny, można wykonać następujące czynności:

• Przejdź do zainstalowanego pliku (tereny/Helppage/widoki/Pomoc/DisplayTemplates/Parameters.cshtml)

• Aktualizacja warunek związany z case ApiParameterSource.FromUri na następujące kwestie:

  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;