Pertanyaan Bagaimana cara saya mendokumentasikan parameter QueryString opsional di ASP.NET WebApi Halaman Bantuan?


Laman Bantuan Api Web ASP.Net tampaknya secara otomatis menentukan apakah parameter ada di Uri Permintaan atau Badan. Bagaimana saya bisa mendokumentasikan parameter opsi yang merupakan parameter QueryString?

Sebagai contoh, saya mungkin memiliki Url RESTful seperti

[GET] api/Books?relatedToBookId=xx

Di mana "relatedToBookId" adalah parameter queryString opsional.

Biasanya parameter yang FromUri atau FromBody dimasukkan ke dalam komentar sebagai

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

8
2017-07-16 21:53


asal


Jawaban:


Anda dapat melakukan hal berikut dan informasi parameter string kueri opsional Anda akan muncul di HelpPage.

Di bawah kode relatedToBookId adalah parameter opsional yang berasal dari 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)

Juga, jika Anda ingin menyebutkan tentang parameter ini menjadi opsional, Anda dapat melakukan hal berikut:

  • Buka file yang diinstal (Area / HelpPage / Views / Help / DisplayTemplates / Parameters.cshtml)

  • Perbarui kondisi yang terkait dengan case ApiParameterSource.FromUri sebagai berikut:

    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;


10
2017-07-16 22:28