如何添加自定义路由¶

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

你可以通过提供自己的 Starlette 应用程序（包括 FastAPI、FastHTML 以及其他兼容的应用程序）来添加自定义路由。你可以在 langgraph.json 配置文件中提供应用程序的路径，让 LangGraph 平台知晓这一点（"http": {"app": "path/to/app.py:app"}）。

定义一个自定义应用程序对象可以让你添加任何你想要的路由，因此你可以做任何事情，从添加一个 /login 端点到编写一个完整的全栈 Web 应用程序，所有这些都可以在一次 LangGraph 部署中完成。

以下是一个使用 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

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 云平台，也可以部署到你自己的托管平台。

后续步骤¶

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