如何添加自定义路由¶

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

您可以通过提供自己的 Starlette 应用程序（包括 FastAPI、FastHTML 和其他兼容的应用程序）来添加自定义路由。您可以通过在 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"
  }
  // 其他配置选项如认证、存储等
}

启动服务器¶

在本地测试服务器：

langgraph dev --no-browser

如果你在浏览器中访问 localhost:2024/hello（2024 是默认的开发端口），你应该会看到 /hello 端点返回 {"Hello": "World"}。

覆盖默认端点

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

部署¶

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

下一步¶

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