Амперсанд & неправильно представлен в отличном пользовательском интерфейсе документации WEB API, когда он находится внутри разметки кода - PullRequest
Новая
       36

Амперсанд & неправильно представлен в отличном пользовательском интерфейсе документации WEB API, когда он находится внутри разметки кода

0 голосов
/ 08 июля 2019

Я пытаюсь добавить замечания к конечной точке API с помощью XML-комментариев, используя "Swashbuckle.AspNetCore" Version = "4.0.1".

Проблема в амперсандах внутри блоков разметки кода.Они не отображаются правильно или комментарии не отображаются вообще.

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

    /// <summary>
    /// Gets all entries
    /// </summary>
    /// <remarks>
    /// Sample request:
    /// ```
    ///     GET <![CDATA[ /api/entries/1?month=5&day=2 ]]>
    /// ```
    /// </remarks>
    [HttpGet("/all")]
    public IActionResult Get(int month, int day)
    {
        return Ok();
    }

Вместо просмотра

Пример запроса: 

GET  /api/entries/1?month=5&amp;day=2

Хотелось бы увидеть

Пример запроса: 

GET  /api/entries/1?month=5&day=2
...