3
respostas

Gerar uma entrada rest para download de arquivo ZIP.

Boa tarde amigos. Estou tentando criar no swagger editor um exemplo de uma chamada rest para fazer o download de um arquivo ZIP mas não estou conseguindo. Pesquisando na net descobri que o Content-Type ZIP só é suportado pela OpenAPI 3.0 mas não achei nenhum exemplo na net.. Alguém aqui saberia indicar como seria um exemplo de uma entrada no swagger editor para download de um zip ? Muito obrigado.

3 respostas

Oi Cristiano, tudo bem?

OpenAPI 3.0:

parameters:
  - name: 'zipCode'
    in: 'query'
    schema:
      type: 'string'
      format: 'zip-code'
    examples:
      zip-example: 
        $ref: '#/components/examples/zip-example'

OpenAPI 2.0:

paths:
  /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: string
            format: binary
          headers:
            Content-Disposition:
              type: string
              description: the value is `attachment; filename="name.zip"`

Fantástico. Muito obrigado pela ajuda.

Por nada CRISTIANO, bons estudos :)