跳到内容

如何添加自定义路由

将代理部署到 LangGraph 平台时,您的服务器会自动暴露用于创建运行和线程、与长期内存存储交互、管理可配置助手以及其他核心功能的路由(查看所有默认 API 端点)。

您可以通过提供自己的 Starlette 应用程序(包括 FastAPIFastHTML 和其他兼容应用程序)来添加自定义路由。您可以通过在 langgraph.json 配置文件中提供应用程序的路径来让 LangGraph 平台识别此设置。

定义自定义应用对象允许您添加所需的任何路由,因此您可以执行从添加 /login 端点到编写整个全栈 Web 应用程序的任何操作,所有这些都部署在单个 LangGraph 服务器中。

以下是使用 FastAPI 的示例。

创建应用

从**现有**的 LangGraph 平台应用程序开始,将以下自定义路由代码添加到您的 webapp.py 文件中。如果您是从头开始,可以使用 CLI 从模板创建新应用程序。

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

拥有 LangGraph 项目后,添加以下应用程序代码

# ./src/agent/webapp.py
from fastapi import FastAPI

app = FastAPI()


@app.get("/hello")
def read_root():
    return {"Hello": "World"}

配置 langgraph.json

将以下内容添加到您的 langgraph.json 配置文件中。确保路径指向您在上面创建的 app.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

如果您在浏览器中导航到 localhost:2024/hello2024 是默认的开发端口),您应该会看到 /hello 端点返回 {"Hello": "World"}

覆盖默认端点

您在应用程序中创建的路由优先于系统默认路由,这意味着您可以覆盖并重新定义任何默认端点的行为。

部署

您可以将此应用程序原样部署到 LangGraph 平台或您自托管的平台。

后续步骤

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