Come si documenta un parametro QueryString facoltativo nelle pagine della Guida di ASP.NET WebApi?

Question

Le pagine della Guida in linea di ASP.Net Web sembrano determinare automaticamente se un parametro è nell'URL o nel corpo della richiesta. Come posso documentare i parametri delle opzioni che sono parametri di QueryString?

Per esempio ho può avere un URL RESTful come

[GET] api/Books?relatedToBookId=xx 

Dove "relatedToBookId" è un parametro queryString opzionale.

Normalmente i parametri che sono FromUri o FromBody sono messi nei commenti come

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

Answer 1

Si potrebbe fare quanto segue e il vostro facoltativo informazioni parametro di stringa di query si presentava nel helppage.

Nel seguente codice relatedToBookId è un parametro facoltativo proveniente dalla stringa di query.

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

Inoltre, se si desidera parlare su questo parametro è facoltativo, è possibile effettuare le seguenti:

• Vai alla scheda installata (Aree/helppage/Vista/Aiuto/DisplayTemplates/Parameters.cshtml)

• Aggiornare la condizione relativa a case ApiParameterSource.FromUri al seguente:

  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;