2016-04-26 2 views
1

У меня проблема, аналогичная описанной here и here. У меня есть служба, которая возвращает файл PDF в виде вложения с заголовком Content-Disposition. Это работает, когда я вызываю конечную точку из браузера - файл загружается. На Swagger UI я получаю ссылку загрузки после вызова службы с типом контента application/pdf ответа, однако, что ссылка загружает пустой файл в формате PDF:Swagger - вызов службы, которая возвращает файл, не работает должным образом

enter image description here

Обратите внимание, что мой swagger.json генерируются излагают (версия 2.3.0) и соответствующая часть выглядит следующим образом:

"responses": { 
    "200": { 
    "schema": { 
    "description": "", 
    "$ref": "#/definitions/json_File" 
    }, ... 

Я попытался добавить "type": "file" к этому, но не решить проблему. Что здесь может быть не так?

ответ

1

Вы можете документировать тип возвращаемого ответа (200) в виде двоичного (формата) вместо того, чтобы:

responses: 
    '200': 
     description: successful operation 
     schema: 
     type: string 
     format: binary 

В соответствии со спецификацией, «двоичный» (формат) относится к «любой последовательности октетов »

Ref: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types

+0

Я попробовал это, но я все еще с той же проблемой. Согласно последнему комментарию [здесь] (https://github.com/swagger-api/swagger-ui/issues/374) тип должен быть 'file'. – Egemen

Смежные вопросы