Misalnya, saya ingat pernah membaca bahwa Anda dapat membuat tabel dalam XML dengan menulis sesuatu yang mirip dengan berikut ini:

||__Column__||                              
||    row   ||

Sayangnya, saya tidak dapat mengingat sumbernya, atau apa namanya. Apakah ada tempat yang telah mendokumentasikan semua hal kecil yang rapi ini, jika tidak, dapatkah seseorang menyinarinya?

Saya tidak sepenuhnya yakin apakah di atas eksklusif untuk swashbuckle, atau XML umum. Harap edit pertanyaan ini jika ini tentang XML secara umum. Jika Anda tidak bisa - beri tahu saya.

0
SpiritBob 19 Maret 2020, 18:29

1 menjawab

Jawaban Terbaik

Dokumentasi XML dasar terlihat seperti ini:

/// <summary>
/// Retrieves a specific product by unique id
/// </summary>
/// <remarks>Awesomeness!</remarks>
/// <response code="200">Product created</response>
/// <response code="400">Product has missing/invalid values</response>
/// <response code="500">Oops! Can't create your product right now</response>
[HttpGet("{id}")]
[ProducesResponseType(typeof(Product), 200)]
[ProducesResponseType(typeof(IDictionary<string, string>), 400)]
[ProducesResponseType(500)]
public Product GetById(int id)

Patut ditunjukkan bahwa Anda harus mengaktifkannya:
https://github.com/domaindrivendev/Swashbuckle.AspNetCore# sertakan-deskripsi-dari-xml-komentar

Tabel yang Anda tampilkan terlihat seperti markup mungkin yang Anda coba lakukan adalah menambahkannya di dokumentasi...
Anda dapat memasukkan lebih banyak di <remarks>, HTML dan Markup adalah sintaks yang valid

    /// <summary>
    /// Testing the summary on the ApiExplorerController
    /// </summary>
    ///
    /// <remarks>
    /// Testing the description on the ApiExplorerController
    /// This is a second line
    /// Here is a link to <a href="https://github.com/heldersepu">my GitHub profile</a>
    /// <br/>
    /// Some HTML styling: <b>BOLD</b> <i>italics</i>
    /// <ul>
    /// <li>Item one</li>
    /// <li>Item two</li>
    /// </ul>
    /// <pre>Text in a pre element</pre>
    ///
    /// <h1>Header1</h1>
    /// <h2>Header2</h2>
    /// <h3>Header3</h3>
    /// </remarks>
    public IEnumerable<string> Get()

Begini tampilannya di UI:
http://swagger-net-test .azurewebsites.net/swagger/ui/index?filter=ApiExplorer#/ApiExplorer/ApiExplorer_Get


Berikut adalah tabel markup

    ///<summary>Post</summary>
    /// <remarks>
    /// Testing Markdown table
    /// | a | b | c | d | e |
    /// |---|---|---|---|---|
    /// | 3 | 0 | 7 | 4 | 1 |
    /// | 4 | 1 | 8 | 5 | 2 |
    /// | 5 | 2 | 9 | 6 | 3 |
    /// </remarks>
    [Route("Post Arrays")]
    public Arrays Post(Arrays arrays)

Tabel sedikit terbentang di UI:
http://swagger-net-test .azurewebsites.net/swagger/ui/index?filter=ArrayTest#/ArrayTest/ArrayTest_Post

1
Helder Sepulveda 22 Maret 2020, 20:23