FastAPI搭配Uvicorn运行时如何正确自定义响应头Server字段值
FastAPI 基于 Uvicorn 运行时自定义 Server 响应头的正确实现
前期尝试方案的失效原因
- 自定义中间件赋值出现头值拼接的问题:HTTP响应头本身支持同名字段携带多个值,Uvicorn默认的
server: uvicorn响应头是在请求处理链路的最外层追加的,在自定义中间件中直接给response.headers['server']赋值时,不会覆盖原有同名字段,只会新增一个同名字段,最终返回时两个值就会拼接成uvicornfirstproject。 - 启动脚本传参出现加载报错的问题:
uvicorn.run()的第一个参数是纯ASGI应用导入路径(格式为模块路径:应用实例名),不能把命令行参数直接拼接在路径字符串里,否则Uvicorn会把整串内容当成要查找的应用属性名,自然会报找不到对应属性的加载错误。
可落地的正确实现方式
方式一:通过Uvicorn原生启动配置指定自定义响应头(推荐)
Uvicorn本身支持原生配置自定义响应头,对应配置项headers接收键值对元组组成的列表,这个配置的生效层级是响应链路的最外层,会直接替换掉默认的server: uvicorn值,不会出现多值拼接的问题。
示例启动代码:
# start_server.py import uvicorn from app.main import app if __name__ == "__main__": uvicorn.run( "start_server:app", host="0.0.0.0", port=8000, reload=True, # 配置自定义响应头,覆盖默认Server值 headers=[("server", "firstproject")] )
方式二:通过HTTP中间件实现,需先移除原有同名字段
如果一定要用中间件逻辑实现自定义头,需要先删除响应中已存在的server头字段,再赋值自定义值,避免多值拼接:
@app.middleware("http") async def add_custom_header(request, call_next): response = await call_next(request) # 先移除默认的Server头,避免和新增值拼接 if "server" in response.headers: del response.headers["server"] response.headers["server"] = "firstproject" return response
注意:这种中间件方式的生效层级低于Uvicorn的外层响应处理逻辑,如果Uvicorn在中间件执行完之后才追加默认Server头,依然会出现自定义值被覆盖的问题,因此优先推荐使用Uvicorn启动配置的方案实现。
内容的提问来源于stack exchange,提问作者Himal Acharya
相关产品推荐
相关产品推荐

