跳到内容

如何添加自定义中间件

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

添加中间件使您能够在整个部署中全局拦截和修改请求和响应,无论是访问您的自定义端点还是内置的 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 平台或您自托管的平台。

下一步

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