如何添加自定义中间件

在 LangGraph 平台上部署代理时，你可以向服务器添加自定义中间件，以处理诸如记录请求指标、注入或检查请求头以及实施安全策略等横切关注点，而无需修改核心服务器逻辑。这与添加自定义路由的方式相同——你只需提供自己的 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"
  }
  // 其他配置选项，如身份验证、存储等。
}

启动服务器

在本地测试服务器：

langgraph dev --no-browser

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

部署

你可以按原样将此应用部署到托管的 langgraph 云平台，也可以部署到你自己托管的平台。

后续步骤

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

Comments