跳至主要內容

伺服器

Mastra 會透過 src/mastra/ 直屬的 server.ts 檔案設定其 HTTP 伺服器。伺服器會將 Agent、Workflow 及其他已註冊的基礎功能公開為 REST 端點,而該檔案預設匯出的 ServerConfig 結構,與你傳給 new Mastra() 的結構相同。

本頁說明檔案式慣例。如需了解伺服器功能、中介軟件、自訂路由、自動產生的 API 文件及部署行為,請參閱伺服器概覽

快速開始
快速開始 的直接連結

建立 src/mastra/server.ts,並預設匯出一個 ServerConfig 物件:

src/mastra/server.ts
import type { ServerConfig } from '@mastra/core/server'

export default {
port: 4111,
host: '0.0.0.0',
} satisfies ServerConfig

常用設定
常用設定 的直接連結

server.ts 可以設定與程式碼註冊相同的伺服器選項:

需要使用
綁定至部署平台的地址hostport
限制瀏覽器存取cors
加入 webhook 或健康狀態檢查apiRoutes
啟用自動產生的 API 文件build.openAPIDocsbuild.swaggerUI

相關範例請參閱 Mastra 伺服器中介軟件自訂 API 路由

與程式碼設定的優先次序
與程式碼設定的優先次序 的直接連結

以程式碼註冊的伺服器設定優先於 server.ts。套用檔案式伺服器設定時,系統會保留啟動期間加入的路由,例如頻道 webhook。