跳转至

如何添加自定义路由

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

你可以通过提供自己的 Starlette 应用(包括 FastAPIFastHTML 和其他兼容应用)来添加自定义路由。你需要在 langgraph.json 配置文件中提供应用的路径来让 LangGraph Platform 感知它。

定义自定义应用对象让你可以添加任何你想要的路由,因此你可以从添加 /login 端点到编写完整的全栈 Web 应用,所有这些都部署在单个 LangGraph Server 中。

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

创建应用

现有的 LangGraph Platform 应用开始,将以下自定义路由代码添加到你的 webapp 文件中。如果你从零开始,可以使用 CLI 从模板创建新应用。

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

一旦你有了 LangGraph 项目,添加以下应用代码:

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

# highlight-next-line
app = FastAPI()


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

配置 langgraph.json

将以下内容添加到你的 langgraph.json 配置文件中。确保路径指向你上面创建的 webapp.py 文件中的 FastAPI 应用实例 app

{
  "dependencies": ["."],
  "graphs": {
    "agent": "./src/agent/graph.py:graph"
  },
  "env": ".env",
  "http": {
    "app": "./src/agent/webapp.py:app"
  }
  // 其他配置选项如 auth、store 等
}

启动服务器

在本地测试服务器:

langgraph dev --no-browser

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

覆盖默认端点

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

部署

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

后续步骤

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