如何添加自定义路由

将 agent 部署到 LangSmith Deployment 时，服务器会自动暴露用于创建 run 和 thread、与长期记忆 store 交互、管理可配置 assistant 以及其他核心功能的 routes（查看所有默认 API 端点）。

你可以通过提供自己的 app 对象并在 langgraph.json 中传入其路径来添加自定义路由（例如 Python 中的 Starlette 应用或 TypeScript 中的 Hono 应用）。

定义自定义 app 对象可以让你添加任意路由，因此你可以从添加 /login 端点，到编写整个全栈 Web 应用，全部部署在单个 Agent Server 中。

以下是 Python 和 TypeScript 的示例。

创建应用

从现有的 LangSmith 应用开始，将以下自定义路由代码添加到你的 app 文件中。如果从零开始，你可以使用 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 实例。

{
  "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 端点返回 JSON 响应。对于 TypeScript 示例，请访问 localhost:2024/custom/hello。

TypeScript 的 http.app 配置在本地开发（langgraph dev）和 Docker（langgraph up）中均可工作。

NOTE

遮蔽默认端点 你在 app 中创建的路由优先于系统默认路由，这意味着你可以遮蔽并重新定义任何默认端点的行为。

部署

你可以将此应用按原样部署到 LangSmith 或自托管平台。

后续步骤

现在你已为部署添加了自定义路由，可以使用同样的技术进一步自定义服务器行为，例如定义自定义中间件和自定义 lifespan 事件。

---