Search code examples
apigoswaggeropenapigo-swagger

Correct media type for swagger spec for downloading zip file

I am creating an api which allows downloading a zip file, so for this I am looking for correct media type for sending this zip file as response in swagger "2.0" specification.

My current api spec looks like this

/config:
  get:
    produces:
      - application/zip
    responses:
        200: # OK
          description: All config files
          schema:
            type: string
            format: binary

I have compiled this spec with "go-swagger" and implemented the backend for this, but when try to call this API I get this error

http: panic serving 127.0.0.1:20366: applicationZip producer has not yet been implemented

In the documentation of swagger I don't see this media type

Official swagger media types

So then what should be the correct media type if we want to provide an API to download a zip file. Thanks in advance

Solution

  • You should use "application/octet-stream" for implementing api that downloads file as an attachment , and since its Producer is already implemented by default so you won't face this issue.