Octri icon

Octri

Octri 將 OpenAPI、Swagger、Postman 或 AsyncAPI 規格轉換為可編輯 API 文件、支援十種語言的可設定 SDK、MCP 工具與正式環境監控,讓團隊以單一規格串連 API 交付與可觀測性流程。

Octri

以單一規格打造 API 工具鏈

Octri 是一個開發者平台,可讓 API 規格依序經過文件、SDK 產生、代理程式存取與正式環境監控。它接受多種常見的 API 描述格式,將其正規化為 OpenAPI 3.1,並使用產生的模型建立文件網站、用戶端函式庫、MCP 伺服器與遙測工作流程。

此平台旨在讓這些輸出內容與來源規格保持連結。團隊可以編輯產生的參考內容、撰寫獨立指南、依照自身慣例設定用戶端,並在合併規格變更後重新產生。監控功能可以編譯至產生的 SDK 中,或另外加入後端,因此團隊無須部署監控代理程式,即可檢視錯誤、追蹤記錄、服務關係、正常運作時間與回歸問題。

核心功能

規格正規化

匯入 JSON 或 YAML 格式的 OpenAPI 3.0 或 3.1、Swagger 2.0、Postman 或 AsyncAPI 檔案,然後將其正規化為 OpenAPI 3.1,供後續產品使用。

API 文件工作室

產生可搜尋的參考頁面、直接編輯內容、加入 MDX 或視覺化指南,並在自訂網域上發布結果。文件更新後,可依變更過的規格重新產生。

互動式文件

提供由結構描述驅動的即時主控台,使用 API 的驗證方式傳送實際請求,並根據讀者輸入產生程式碼片段。搜尋功能與選用的 AI 聊天可協助讀者找到答案。

可設定的 SDK 產生

為十種指定語言產生符合各語言慣用方式的用戶端函式庫,並提供各語言專屬的命名、分頁、冪等性、程式碼樣式、傳輸方式與專案結構設定。用戶端可發布至套件登錄檔。

SDK 與 API 監控

將遙測資料加入產生的 SDK,或使用獨立的後端套件,而不必部署代理程式。監控提供結構化記錄、分組問題、追蹤記錄、服務地圖、N+1 查詢偵測、合成式正常運作時間檢查與警示。

代理程式可讀取的 API 存取

將文件發布為 Markdown 並透過 llms.txt 提供,且將 API 端點公開為 Claude、Cursor 及其他 MCP 用戶端可呼叫的工具。可從網站設定中停用機器可讀取的存取方式。

實際使用情境

  • 發布實用的 API 參考文件

    匯入現有的 API 規格,為其端點產生參考頁面,接著修正描述、加入範例,並發布面向讀者的網站,讓讀者不必直接從來源 YAML 著手。

  • 維護用戶端函式庫

    為每種目標語言設定命名、分頁、冪等性、傳輸方式與資料夾慣例,接著將產生的用戶端發布至套件登錄檔,並在變更發布時查看建置歷程。

  • 讓代理程式能使用 API

    以轉譯頁面、Markdown 與 llms.txt 索引等形式公開相同的 API 文件,同時允許 Claude 或 Cursor 等 MCP 用戶端將已記錄的端點作為工具呼叫。

  • 調查正式環境中的 API 故障

    將遙測資料編譯至產生的 SDK,或安裝後端套件,接著透過分組問題、追蹤記錄、服務地圖、查詢偵測、正常運作時間檢查與警示,調查客戶回報的故障。

Pros and Cons

Pros

  • 單一規格即可驅動文件、SDK、MCP 工具與監控工作流程。
  • 產生的文件仍可編輯;除非移除手動修改,否則後續重新產生時會保留這些修改。
  • 文件網站整合參考頁面、指南、搜尋、即時請求主控台與機器可讀內容。
  • SDK 輸出支援十種語言與各語言專屬慣例,無須團隊分叉產生的用戶端。
  • 監控功能可納入產生的 SDK,或加入現有的後端套件;產品也說明了用戶端與資料匯入時的資料遮罩機制。

Cons

  • 最詳細的工作流程與設定資訊集中於 API 文件、SDK 產生、MCP 存取與監控;在這些領域之外有需求的團隊可能需要進一步確認是否適用。
  • AI 文件與聊天功能會使用額度,SDK 語言額度也會依方案而異;部分方案的額外語言需付費加購。
  • 產生器與文件轉譯器的客戶自行管理部署僅限 Enterprise 方案。

FAQ

Octri 支援哪些規格格式?

Octri 支援 OpenAPI 3.0 和 3.1、Swagger 2.0、Postman 及 AsyncAPI 規格,格式可為 JSON 或 YAML。它會將輸入內容正規化為 OpenAPI 3.1。在支援的情況下,您可以透過規格提供基礎 URL 與驗證方案。

Octri 如何處理產生的文件與編輯內容?

文件產生器會針對規格中的路徑與方法建立參考頁面。您可以產生完整 API、僅產生尚未記錄的部分,或產生單一頁面。產生的內容可在發布前直接編輯;除非您明確移除編輯內容,否則後續執行時仍會保留您的修改。

Octri 文件網站包含哪些內容?

發布的網站包含 API 參考頁面、指南、搜尋、即時 Playground,以及可供代理程式讀取的索引。參考頁面可包含端點說明、欄位描述、依狀態提供的錯誤指引、可直接執行的 cURL、JavaScript 與 Python 範例,以及棄用指示。

有哪些 SDK 語言與設定選項可用?

SDK Studio 可為 TypeScript、Python、Go、Java、Dart、Ruby、PHP、Rust、Swift 和 Kotlin 產生用戶端。它支援各語言專屬設定,例如命名空間、分頁、冪等性、程式碼樣式、HTTP 引擎、方法名稱、排除的端點與資料夾結構。自訂 hooks 也可以編譯至用戶端中。

Octri 是代管服務嗎?是否提供免費方案?

Octri 提供免費方案與付費方案。其中一種方案涵蓋文件、SDK、監控與 MCP 伺服器,但可用量與 SDK 語言額度會依方案而異。Enterprise 方案可在客戶自行管理的基礎架構中執行產生器與文件轉譯器;其他方案則由 Octri 提供代管。

Quick Facts

類別
開發者工具
主要輸入
JSON 或 YAML 格式的 OpenAPI、Swagger、Postman 或 AsyncAPI
產生的輸出
文件、SDK、MCP 伺服器與監控工作流程
SDK 語言
TypeScript、Python、Go、Java、Dart、Ruby、PHP、Rust、Swift 與 Kotlin
文件代管
代管的自訂網域網站;Enterprise 方案提供客戶自行管理的轉譯器
定價模式
免費方案加付費方案;其中一種方案涵蓋文件、SDK、監控與 MCP
Octri - AI Tool, Features, Use Cases & Alternatives | UStack