如何添加自定义中间件

在 LangGraph 平台上部署 Agent 时，您可以向服务器添加自定义中间件，以处理诸如记录请求指标、注入或检查标头以及实施安全策略等横切关注点，而无需修改核心服务器逻辑。这与添加自定义路由的工作方式相同 - 您只需要提供您自己的 Starlette 应用（包括 FastAPI、FastHTML 和其他兼容的应用）。

添加中间件使您能够全局拦截和修改跨部署的请求和响应，无论它们是访问您的自定义端点还是内置的 LangGraph 平台 API。

以下是使用 FastAPI 的示例。

仅限 Python

我们目前仅在 langgraph-api>=0.0.26 的 Python 部署中支持自定义中间件。

创建应用

从一个现有的 LangGraph 平台应用程序开始，将以下中间件代码添加到您的 webapp.py 文件中。如果您从头开始，您可以使用 CLI 从模板创建一个新应用。

langgraph new --template=new-langgraph-project-python my_new_project

一旦您拥有 LangGraph 项目，添加以下应用代码

# ./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 文件。

{
  "dependencies": ["."],
  "graphs": {
    "agent": "./src/agent/graph.py:graph"
  },
  "env": ".env",
  "http": {
    "app": "./src/agent/webapp.py:app"
  }
  // Other configuration options like auth, store, etc.
}

启动服务器

在本地测试服务器

langgraph dev --no-browser

现在，对您服务器的任何请求都将在其响应中包含自定义标头 X-Custom-Header。

部署

您可以按原样将此应用部署到托管的 langgraph 云或您自托管的平台。

下一步

既然您已向部署添加了自定义中间件，您可以使用类似的技术来添加自定义路由或定义自定义生命周期事件，以进一步自定义服务器的行为。

评论