Многострочный пример в теле ответа openapi v3

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

Желаемый результат

До сих пор все, что мне удалось сделать, это однострочный пример, как показано ниже:

Пример одной строки


person Mike    schedule 27.12.2017    source источник


Ответы (1)


Вы мало говорите о выбранном вами языке для вашего API или о том, как вы создаете свой swagger.json...

Но да, это возможно. Вот несколько живых примеров:

http://swashbuckletest.azurewebsites.net/swagger/ui/index?filter=Company#/Company/Company_Post

http://swashbuckletest.azurewebsites.net/swagger/ui/index?filter=Polygon#/PolygonVolume/PolygonVolume_Post

http://swashbuckletest.azurewebsites.net/swagger/ui/index?filter=Dictionary#/Dictionary/Dictionary_DeleteEcho



код json для последнего выглядит так:

"delete": {
    "tags": [
      "Dictionary"
    ],
    "operationId": "Dictionary_DeleteEcho",
    "consumes": [
      "application/json",
      "text/json",
      "text/html"
    ],
    "produces": [
      "application/json",
      "text/json",
      "text/html"
    ],
    "parameters": [
      {
        "name": "guids",
        "in": "body",
        "required": true,
        "schema": {
          "type": "array",
          "items": {
            "format": "uuid",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "example": [
            "00000000-0000-0000-0000-000000000000",
            "00000000-0000-0000-0000-000000000000"
          ]
        }
      }
    ],
...
person Helder Sepulveda    schedule 02.01.2018