如何指定在swagger中返回pdf？

Question

我在我的swagger REST API中有一个需要返回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]

都失败了.这甚至可能吗？

Answer 1

使用 Open API 3.0，尝试以下响应：

get:
  summary: Returns the report in the PDF format
  responses:
    '200':
      description: A PDF file
      content:
        application/pdf:
          schema:
            type: string
            format: binary

文档：swagger.io/docs/specification/describing-responses

部分：返回文件的响应

Answer 2

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

在你给出的选项中,这是正确的选择.另外,请务必使用produces: [application/pdf]

如果它失败了,请确保使用最新版本的编辑器.有一个与file最近解决的类型相关的错误.