Swagger如何配置以便可以成功下载Excel吗

Question

有人知道该如何配置Swagger支持下载Excel吗？

为什么点击下载之后 文件打不开呢？ 提示： can't be opened for some reason

代码： Flask + flasgger

    response = make_response(send_file(save_path))
    response.headers["Content-Disposition"] = "attachment; filename=download.xls;"
    return response

---

改成如下配置后 效果一样

    produces:
      - application/octet-stream
    parameters:
      - in: formData
        name: file
        type: file
        required: true
        description: Upload your excel file.
    responses:
      200:
        description: 处理后的文章下载
        schema:
          type: file

虽然页面上多了

但是并未生效 还是一样

Answer 1

你应该把请求的Accept设置成application/octet-stream.
这其实有的奇怪, 因为一般情况下 Excel 文件的 Accept 是application/vnd.ms-excel.
但是由于 flasgger 是使用 swagger-ui 作为前端, 而 Swagger 发送文件类请求是使用 superagent, 使用的是 blob 技术, 需要设置 xhr 的 ResponseType 为blob.
我们看flasgger_static/lib/http.js:

if(this.binaryRequest(accept)) {
    r.on('request', function () {
      if(this.xhr) {
        this.xhr.responseType = 'blob';
      }
    });
  }

SuperagentHttpClient.prototype. binaryRequest = function (accept) {
  if(!accept) {
    return false;
  }
  return (/^image/i).test(accept)
    || (/^application\/pdf/).test(accept)
    || (/^application\/octet-stream/).test(accept);
};

只在 Accept 匹配为image/i,/^application\/pdf/,/^application\/octet-stream/, 才将 responseType 设置成 blob
所以要么将/^application\/vnd.ms-excel/这个匹配加入http.js, 要么将发送的请求全部设置成application/octet-stream.
也就是这样设置produces:
app.py:

@app.route('/excel')
def excel():
    """
    ---
    produces:
      application/octet-stream
    responses:
      200:
        description: description_text
        schema:
          type: file
    """
    save_path = 'demo.xls'
    response = make_response(send_file(save_path))
    response.headers['Content-Disposition'] = 'attachment; filename=demo.xls'
    return response

比如现在的目录结构:

demo.py:

apidocs页面: