Пример Swagger 2 + Response XML с отступом и форматированием - PullRequest
Новая
       9

Пример Swagger 2 + Response XML с отступом и форматированием

0 голосов
/ 10 мая 2019

Я использую Swagger 2 (OAS 2 | OpenAPI Specification V2), чтобы показать пример XML в ответе.Ниже приведен пример XML. 

<GetShipmentsResponse xmlns="http://tempuri.org/">
    <GetShipmentsResult xmlns:a="http://schemas.datacontract.org/2004/07/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:ShipmentDetailDC>
            <a:AirWayNo/>
            <a:CurrentStatus>Shipment delivered</a:CurrentStatus>
            <a:CurrentStatusCategory>C100</a:CurrentStatusCategory>
            <a:CurrentStatusCode>1000</a:CurrentStatusCode>
            <a:DeliveredDate>2019-05-02T18:03:28</a:DeliveredDate>
            <a:DestinationName>SRI LANKA</a:DestinationName>
            <a:OrderDate>2016-01-20T00:00:00</a:OrderDate>
            <a:OriginName>SRI LANKA</a:OriginName>
            <a:Quantity>1</a:Quantity>
            <a:ReceiverName>SRI LANKA SHIPPING INC.</a:ReceiverName>
            <a:ReferenceNo>100000</a:ReferenceNo>
            <a:Remarks>Delivery complete and dues received</a:Remarks>
            <a:StatusCount>8</a:StatusCount>
            <a:TrackingNo>QS10711700286</a:TrackingNo>
            <a:Weight>20</a:Weight>
        </a:ShipmentDetailDC>
    </GetShipmentsResult>
</GetShipmentsResponse>

Я хочу показать это в разделе примеров ответов.Аналогичная вещь описана в OpenAPI 3 здесь .Но мне нужно сделать это в Swagger 2 (OAS2)

. Я попытался сделать следующее. 

responses:
        '200':
          description: "OK"
          examples:
            application/xml: "

            <GetShipmentsResponse xmlns='http://tempuri.org/'> \n
    <GetShipmentsResult xmlns:a='http://schemas.datacontract.org/2004/07/QS.TrackNTraceService.DataContract' xmlns:i='http://www.w3.org/2001/XMLSchema-instance'> \n
        <a:ShipmentDetailDC> \n
            <a:AirWayNo/> \n
            <a:CurrentStatus>Shipment delivered</a:CurrentStatus> \n
            <a:CurrentStatusCategory>C600</a:CurrentStatusCategory>\n
            <a:CurrentStatusCode>6034</a:CurrentStatusCode>\n
            <a:DeliveredDate>2016-01-20T18:03:28</a:DeliveredDate>\n
            <a:DestinationName>PHILIPPINES</a:DestinationName>\n
            <a:OrderDate>2016-01-20T00:00:00</a:OrderDate>\n
            <a:OriginName>PHILIPPINES</a:OriginName>\n
            <a:Quantity>1</a:Quantity>\n
            <a:ReceiverName>BIG GUYS PIZZA PHILS., INC.</a:ReceiverName>\n
            <a:ReferenceNo>107117</a:ReferenceNo>\n
            <a:Remarks>Delivery complete and dues received</a:Remarks>\n
            <a:StatusCount>8</a:StatusCount>\n
            <a:TrackingNo>QS10711700286</a:TrackingNo>\n
            <a:Weight>20</a:Weight>\n
        </a:ShipmentDetailDC>\n
    </GetShipmentsResult>\n
</GetShipmentsResponse>

            "

Есть ли другой способ показать хорошо с отступом XML (вышеупомянутый XML) в Swagger Responseпримеры легко чем такой подход в Swagger 2 (OAS2)?

...