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