如何添加自定义路由¶
在LangGraph平台上部署代理时,您的服务器会自动暴露用于创建运行和线程、与长期记忆存储交互、管理可配置助手以及其他核心功能的路由(查看所有默认API端点)。
您可以通过提供自己的Starlette
应用(包括FastAPI
、FastHTML
和其他兼容的应用程序)来添加自定义路由。您通过在langgraph.json
配置文件中提供应用程序的路径使LangGraph平台意识到这一点。("http": {"app": "path/to/app.py:app"}
)。
定义一个自定义应用程序对象可以让您添加所需的任何路由,因此您可以从添加一个/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
文件中添加以下内容。确保路径指向上面创建的 app.py
文件。
{
"dependencies": ["."],
"graphs": {
"agent": "./src/agent/graph.py:graph"
},
"env": ".env",
"http": {
"app": "./src/agent/webapp.py:app"
}
// 其他配置选项如认证、存储等
}
启动服务器¶
在本地测试服务器:
如果你在浏览器中导航到 localhost:2024/hello
(2024 是默认开发端口),你应该会看到 hello
端点返回 {"Hello": "World"}
。
覆盖默认端点
你在应用程序中创建的路由优先于系统默认设置,这意味着你可以覆盖并重新定义任何默认端点的行为。
部署¶
您可以将此应用程序按原样部署到管理式语言图云平台或您自己的自托管平台上。
下一步¶
现在您已经在部署中添加了一个自定义路由,您可以使用相同的技术进一步自定义服务器的行为,例如定义自定义中间件和自定义生命周期事件。