添加自定义路由¶
在将代理部署到 LangGraph 平台时,您的服务器会自动公开用于创建运行和线程、与长期记忆存储交互、管理可配置助手以及其他核心功能的路由(查看所有默认 API 端点)。
您可以通过提供自己的 Starlette
应用(包括 FastAPI
、FastHTML
和其他兼容应用)来添加自定义路由。通过在 langgraph.json
配置文件中提供应用的路径,可以使 LangGraph Platform 知晓这一点。
定义自定义应用对象可以允许您添加任何所需的路由,因此您可以从添加 /login
端点到编写完整的全栈 Web 应用,所有这些都部署在同一个 LangGraph 服务器中。
下面是一个使用 FastAPI 的示例。
创建应用¶
从**现有**的 LangGraph Platform 应用开始,将以下自定义路由代码添加到您的 webapp.py
文件中。如果您是从头开始,可以使用 CLI 从模板创建新应用。
拥有 LangGraph 项目后,添加以下应用代码:
# ./src/agent/webapp.py
from fastapi import FastAPI
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 等。
}
启动服务器¶
在本地测试服务器:
如果您在浏览器中导航到 localhost:2024/hello
(2024
是默认开发端口),您应该会看到 /hello
端点返回 {"Hello": "World"}
。
覆盖默认端点
您在应用中创建的路由会优先于系统默认路由,这意味着您可以覆盖和重新定义任何默认端点的行为。
部署¶
您可以按原样将此应用部署到 LangGraph 平台或您自托管的平台。
后续步骤¶
既然您已为部署添加了自定义路由,您可以使用相同的技术来进一步自定义服务器的行为,例如定义自定义 自定义中间件 和 自定义生命周期事件。