如何添加自定义路由

在 LangGraph 平台部署代理时，您的服务器会自动暴露用于创建运行和线程、与长期记忆存储交互、管理可配置助手以及其他核心功能的路由（参阅所有默认 API 端点）。

您可以通过提供自己的 Hono 应用来添加自定义路由。您可以通过在 langgraph.json 配置文件中提供应用路径来让 LangGraph 平台知道此事（"http": {"app": "path/to/app.ts:app"}）。

定义自定义应用对象允许您添加任何想要的路由，因此您可以做任何事情，从添加 /login 端点到编写完整的全栈 Web 应用，所有这些都部署在单个 LangGraph 部署中。

创建应用

从现有的 LangGraph 平台应用开始，将以下自定义路由代码添加到您的 app.ts 文件中。如果您从零开始，可以使用 CLI 从模板创建新应用。

npm create langgraph

请确保安装 hono 作为依赖项。

npm install hono

一旦您有了 LangGraph 项目，添加以下应用代码

// ./src/agent/app.ts
import { Hono } from "hono";

export const app = new Hono();

app.get("/hello", (c) => c.json({ hello: "world" }));

配置 langgraph.json

将以下内容添加到您的 langgraph.json 文件中。确保路径指向您上面创建的 app.py 文件。

{
  "graphs": {
    "agent": "./src/agent/graph.ts:graph"
  },
  "env": ".env",
  "http": {
    "app": "./src/agent/app.ts:app"
  }
  // Other configuration options like auth, store, etc.
}

启动服务器

在本地测试服务器

npx langgraph-cli@latest dev --no-browser

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

覆盖默认端点

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

部署

您可以将此应用原样部署到托管的 LangGraph Cloud 或您的自托管平台。

下一步

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