跳到内容

如何添加自定义路由

在 LangGraph 平台上部署 Agent 时，您的服务器会自动公开用于创建运行和线程、与长期记忆存储交互、管理可配置助手以及其他核心功能的路由（查看所有默认 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"
  }
  // Other configuration options like auth, store, etc.
}

启动服务器

在本地测试服务器

langgraph dev --no-browser

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

覆盖默认端点

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

部署

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

下一步

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

评论