Как использовать html-разметку в атрибуте «description» файла swagger.json? - PullRequest
Новая
       119

Как использовать html-разметку в атрибуте «description» файла swagger.json?

1 голос
/ 21 октября 2019

Среда:

NSwag.AspNetCore (12.2.5);

Microsoft.NETCore.App (3.0.0);

Язык: C #

Я отмечаю заголовок некоторых контроллеров следующим выражением: 

///<summary>Controller description</summary>
/// <remarks>
/// <details>
///    <summary>Expand here</summary>
///    <p>Hidden content</p>
///</details>
/// </remarks>
[HttpGet]
[SwaggerTags("NF-e (Nota Fiscal Eletrônica)")]
[Route("api/testes/")]
public string tests()
{
    return "tests";
}

Предполагалось бы получить файл спецификации swagger со следующим содержимым: 

"paths": {
...
    "/api/testes": {
      "get": {
        "tags": [
          "NF-e (Nota Fiscal Eletrônica)"
        ],
        "summary": "Controller description",
        "description": "<details><summary>Expand here</summary><p>Hidden content</p></details>"
        "operationId": "NFe_tests",
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "description": "Chave de acesso à API",
            "schema": {
              "type": "string"
            },
            "default": "980fb195fdecc68069deb67f987573837cf67e0e"
          }
        ],
        "responses": {
          "200": {
            "x-nullable": true,
            "description": "",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    }
...

Toиметь на графическом интерфейсе чванца следующее поведение:

enter image description here

Однако, я получаю следующее: 

"paths": {
...
    "/api/testes": {
      "get": {
        "tags": [
          "NF-e (Nota Fiscal Eletrônica)"
        ],
        "summary": "Controller description",
        "description": "   Expand here\n   Hiden content\n            ",
        "operationId": "NFe_tests",
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "description": "Chave de acesso à API",
            "schema": {
              "type": "string"
            },
            "default": "980fb195fdecc68069deb67f987573837cf67e0e"
          }
        ],
        "responses": {
          "200": {
            "x-nullable": true,
            "description": "",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    }
...

Есть лиЛюбой способ предотвратить подавление html-тегов путем создания атрибута "description" в файле swagger.json?

Я пытался обернуть содержимое тегом! [CDATA [html content here]]. Но все равно не работает должным образом.

Любая помощь будет приветствоваться.

...