主题
如何添加自定义中间件
将 agent 部署到 LangSmith 时,你可以为服务器添加自定义中间件,以处理记录请求指标、注入或检查 header、执行安全策略等事项,而无需修改核心服务器逻辑。其工作方式与添加自定义路由相同。你只需提供自己的 Starlette 应用(包括 FastAPI、FastHTML 和其他兼容应用)。
添加中间件可以让你在整个部署范围内全局拦截和修改请求与响应,无论它们访问的是你的自定义端点还是内置的 LangSmith API。
下面是一个使用 FastAPI 的示例。
NOTE
“仅 Python” 目前仅在 langgraph-api>=0.0.26 的 Python 部署中支持自定义中间件。
创建应用
从现有的 LangSmith 应用开始,将以下中间件代码添加到你的 webapp.py 文件中。如果从零开始,你可以使用 CLI 从模板创建新应用。
bash
langgraph new --template=new-langgraph-project-python my_new_project有了 LangGraph 项目后,添加以下应用代码:
python
# ./src/agent/webapp.py
from fastapi import FastAPI, Request
from starlette.middleware.base import BaseHTTPMiddleware
app = FastAPI()
class CustomHeaderMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
response = await call_next(request)
response.headers['X-Custom-Header'] = 'Hello from middleware!'
return response
# Add the middleware to the app
app.add_middleware(CustomHeaderMiddleware)配置 langgraph.json
将以下内容添加到你的 langgraph.json 配置文件。确保路径指向你上面创建的 webapp.py 文件。
json
{
"dependencies": ["."],
"graphs": {
"agent": "./src/agent/graph.py:graph"
},
"env": ".env",
"http": {
"app": "./src/agent/webapp.py:app"
}
// Other configuration options like auth, store, etc.
}自定义中间件顺序
默认情况下,自定义中间件在认证逻辑之前运行。要在认证之后运行自定义中间件,请在 http 配置中将 middleware_order 设置为 auth_first。(从 API server v0.4.35 及更高版本开始支持此自定义。)
json
{
"dependencies": ["."],
"graphs": {
"agent": "./src/agent/graph.py:graph"
},
"env": ".env",
"http": {
"app": "./src/agent/webapp.py:app",
"middleware_order": "auth_first"
},
"auth": {
"path": "./auth.py:my_auth"
}
}启动服务器
在本地测试服务器:
bash
langgraph dev --no-browser现在,对你服务器的任何请求都会在其响应中包含自定义 header X-Custom-Header。
部署
你可以将此应用按原样部署到云端或自托管平台。
后续步骤
现在你已为部署添加了自定义中间件,可以使用类似技术添加自定义路由或定义自定义 lifespan 事件,进一步自定义服务器行为。