Загрузка файла модели OpenAPI 2.0, строка типа: двоичный файл против файла типа - PullRequest
Новая
       10

Загрузка файла модели OpenAPI 2.0, строка типа: двоичный файл против файла типа

0 голосов
/ 27 сентября 2018

Я немного запутался, как смоделировать загрузку файла с помощью Swagger / OpenAPI v2.Возьмите небольшой пример: 

/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 Ответ

0 голосов
/ 03 октября 2018

В приватной беседе с людьми из OpenAPI на gitter.im мне сказали следующее:

В OAS v3 вместо file было заменено type: string, format: binary, так что если выпланируя обновить вашу спецификацию до OAS v3, я бы посоветовал вам использовать бинарный файл с этого момента

...