跳到内容

如何添加自定义中间件

在将代理部署到 LangGraph 平台时,您可以为服务器添加自定义中间件,以处理请求指标记录、注入或检查标头以及强制执行安全策略等问题,而无需修改核心服务器逻辑。这与添加自定义路由的工作方式相同。您只需提供自己的 Starlette 应用(包括 FastAPIFastHTML 和其他兼容应用)。

添加中间件可让您在整个部署中全局拦截和修改请求和响应,无论它们是访问您的自定义端点还是内置的 LangGraph 平台 API。

下面是一个使用 FastAPI 的示例。

仅限 Python

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

创建应用

从一个现有的 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 平台或您的自托管平台。

下一步

现在您已将自定义中间件添加到您的部署中,您可以使用类似的技术来添加自定义路由或定义自定义生命周期事件,以进一步自定义服务器的行为。