代码之家 › 专栏 › 技术社区 › Marcel Stör

模型OpenAPI 2.0文件下载,键入string:binary vs. 类型文件

openapi swagger-2.0 swagger

0

Marcel Stör · 技术社区 · 6 年前

/files/{name}.zip:
  get:
    summary: Returns the requested ZIP file as "file download" i.e. with content-disposition = attachment
    produces:
      - application/zip
    parameters:
      - name: name
        in: path
        required: true
        type: string
    responses:
      200:
        description: OK
        schema:
          type: file      # <- what is it?
        headers:
          Content-Disposition:
            type: string
            description: the value is `attachment; filename="name.zip"`

我使用什么作为响应类型?它是 type: string format: binary 或者只是 type: file

我在看 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#response-object (响应数据类型) file

还有,使用 Content-Disposition

注意到自己,也看了一下

1 回复 | 直到 6 年前

1

8

Marcel Stör 6 年前

在与gitter.im上的OpenAPI人员的私人对话中,我被告知如下。

在OAS v3中, file 已被替换为 type: string, format: binary 因此,如果您打算最终将您的规范升级到oasv3,我建议您从现在开始使用二进制

推荐文章

Igor · 将openapi v3与open liberty结合使用

6 年前

Noel · ServiceStack-使用OpenApiFeature自定义生成的OpenAPI JSON

6 年前

Kenneth Mascarenhas · 使用$ref将Openapi YAML配置部署到Google端点

6 年前

Timothy Nott Wesley Wong · 在为Google云端点编写规范时,是否有任何规则管理operationId?

6 年前

Bit Fracture · Swagger 2.0语义错误,路径参数为$ref

7 年前

cchapman Tim Wan · 什么时候应该在开放API中使用$ref和对象id

7 年前

JuKe · 如何在OpenAPI 2.0中为相同的操作定义路径和formData参数?

7 年前