Flask如何实现浏览器直接打开static目录下YAML文件而非下载

问题原因 #

Flask 底层依赖 Werkzeug 处理静态资源响应，默认 MIME 类型映射表没有收录 .yml/.yaml 后缀的对应类型，会将这类文件标记为 application/octet-stream（通用二进制流类型）。浏览器收到该类型响应时默认触发下载逻辑；而 .txt 对应 text/plain、.json 对应 application/json，都属于浏览器识别为可直接渲染的文本类型，因此会直接在页面内预览。

解决方法 #

方案1：全局注册YAML文件MIME类型（推荐）

在Flask应用初始化阶段，给应用的MIME类型映射表追加YAML后缀对应的文本类型，所有YAML静态文件会自动返回正确响应头，无需额外修改其他逻辑，修改后的app.py代码如下：

# app.py
from flask import Flask

app = Flask(__name__)
# 注册yml、yaml后缀对应的标准MIME类型，标记为可直接预览的文本类型
app.mimetype_map.add_type("text/yaml", ".yml")
app.mimetype_map.add_type("text/yaml", ".yaml")

if __name__ == '__main__':
    app.run(debug=True)

配置完成后重启服务，再访问YAML文件就会直接在浏览器内预览，不会触发下载。如果希望YAML文件和纯文本文件的渲染逻辑完全一致，也可以将MIME类型替换为text/plain。

方案2：通过响应钩子细粒度调整响应头

如果不需要全局配置，只想对特定路径的YAML文件调整预览逻辑，可以用after_request钩子在响应返回前修改对应头信息：

# app.py
from flask import Flask, request

app = Flask(__name__)

@app.after_request
def adjust_yml_response_header(response):
    # 匹配static路径下的yml、yaml文件请求
    if request.path.startswith("/static/") and (request.path.endswith(".yml") or request.path.endswith(".yaml")):
        # 设置文本类型编码
        response.headers["Content-Type"] = "text/yaml; charset=utf-8"
        # 明确告知浏览器直接在页面内展示资源，不要触发下载
        response.headers["Content-Disposition"] = "inline"
    return response

if __name__ == '__main__':
    app.run(debug=True)

内容的提问来源于stack exchange，提问作者m_tofu