Возможные XML теги / функции для использования в документах чванства? - PullRequest
Новая
       53

Возможные XML теги / функции для использования в документах чванства?

0 голосов
/ 19 марта 2020

Например, я помню, как читал, что вы можете создать таблицу в XML, написав что-то похожее на следующее: 

||__Column__||                              
||    row   ||

К сожалению, я не могу вспомнить источник или что это было называется. Есть ли место, где документированы все эти аккуратные мелочи, если нет, может кто-нибудь пролить на них свет?

Я не совсем уверен, было ли вышеупомянутое исключительно для swashbuckle или общего XML. Пожалуйста, отредактируйте этот вопрос, если он примерно равен XML. Если не можешь - дай мне знать.

1 Ответ

1 голос
/ 22 марта 2020
Документация

Basi c XML выглядит следующим образом: 

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

Стоит отметить, что вы должны включить:
https://github.com/domaindrivendev/Swashbuckle.AspNetCore#include -description-from- xml -comments

Таблица, которую вы показываете, выглядит как разметка. Возможно, вы пытаетесь добавить это в документацию ...
Вы можете включить больше в <remarks>, HTML и разметка является допустимым синтаксисом 

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

Заголовок1

///

Заголовок2

///

Заголовок3

/// publi c IEnumerable Get ()

Вот как это выглядит в пользовательском интерфейсе:
http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=ApiExplorer# / ApiExplorer / ApiExplorer_Get

Вот таблица разметки 

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

Таблица немного растянута в интерфейсе пользователя:
http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=ArrayTest# / ArrayTest / ArrayTest_Post

...