Как указать, что pdf возвращается в чванстве?

У меня есть вызов get в моем API REST swagger, который должен вернуть файл PDF. Нет четкого примера/документации о том, как это сделать, не вызывая синтаксической ошибки.

  responses:
    200:
      description: Returns PDF
      schema: [application/pdf]

а также

  responses:
    200:
      description: Returns PDF
      schema: 
        type: file

а также

  responses:
    200:
      description: Returns PDF
      schema:
        type:  [application/pdf]

все терпят неудачу. Это вообще возможно?


swagger swagger-ui swagger-2.0 swagger-editor
person Scottingham    schedule 24.08.2015    source источник

Ответы (1)


arrow_upward
22
arrow_downward 

  responses:
    200:
      description: Returns PDF
      schema: 
        type: file

Из предложенных вами вариантов, это правильный вариант. Также обязательно используйте produces: [application/pdf]

Если это не удается для вас, убедитесь, что вы используете последнюю версию редактора. Недавно была исправлена ​​ошибка, связанная с типом file.

person Ron    schedule 25.08.2015
comment
С Open API 3.0 попробуйте ниже responses: '200': description: A PDF file content: application/pdf: schema: type: string format: binary Документация: swagger.io/docs/specification/describing-responses Раздел: Ответ, возвращающий файл - person dev1918; 20.02.2020