Scalar logo

Scalar

認領

Scalar 是一個開發者平台,提供 API 文件、SDK 產生、API 測試與 Registry 工作流程,建立於 OpenAPI 等開放標準,協助 API 團隊撰寫文件、產生用戶端函式庫並保持介面同步。

Scalar preview

API 文件、SDK 與用戶端的開發者工具

Scalar 是一個開發者平台,提供 API 文件、SDK 產生、API 測試與 API registry 工作流程。網站將其定位為「The API Company」,並以開放標準為核心,特別是 OpenAPI;在相關產品中也可見對 AsyncAPI 與 JSON Schema 的支援。

在各產品頁面中,Scalar 將其工具定位為一組相互串連的能力:撰寫文件、產生 SDK 與用戶端、在離線優先的用戶端中測試 API,並讓輸出與 Git 及原始 API 描述保持同步。依產品不同,平台可透過代管體驗、CLI、以及桌面或瀏覽器式用戶端使用。

核心功能

文件撰寫

使用 Markdown 或 MDX 撰寫產品指南與 API 文件,加入自訂 HTML/CSS/JS,並透過代管文件或 CLI 發布成果。

API 參考

根據 OpenAPI 與 AsyncAPI 文件產生互動式 API 參考,讓文件與 API 描述保持一致。

以 Git 為基礎的發布

透過雙向 Git 同步、GitHub Actions、預覽部署,以及從儲存庫或 CLI 發布的工作流程,讓文件保持最新。

SDK 產生

根據 OpenAPI 產生具型別安全的 SDK 與 CLI,並支援自訂程式碼、程式碼範例、驗證與檔案串流。

API 測試用戶端

使用離線優先的 API 用戶端匯入 OpenAPI 描述、整理 collections、執行請求腳本,並驗證回應。

API registry

透過深度 Git 整合、CI/CD 工作流程,以及面向 registry 的發布機制,管理 OpenAPI 文件,適合需要版本化 API 資產的團隊。

團隊使用 Scalar 的常見方式

  • 發布開發者文件

    使用 Docs 以 Markdown 或 MDX 撰寫指南,結合 API 參考,並從 GitHub 或 CLI 發布,同時讓網站與儲存庫保持同步。

  • 從 OpenAPI 產生用戶端函式庫

    使用 SDK 產生將 OpenAPI 文件轉換為具型別安全的用戶端函式庫或 CLI,並在 API 規格變更時管理更新。

  • 互動式測試 API

    使用 API Client 匯入 OpenAPI 描述、傳送請求、整理 collections,並加入請求前或回應後腳本進行測試。

  • 在 registry 中管理 API 定義

    使用 registry 工作流程透過 Git 整合與 CI/CD 自動化來管理與版本化 OpenAPI 文件,適合維護共享 API 資產的團隊。

  • 跨團隊協調 API 工作流程

    使用代管與瀏覽器式工具,在需要文件、用戶端存取或預覽部署的團隊之間協作,而無須各自額外建置。

Pros and Cons

Pros

  • 在單一產品家族中涵蓋多種 API 工作流程,包括文件、SDK、API 用戶端與 registry。
  • 以 OpenAPI 與相關開放標準為核心,使工作流程以來源驅動,而非手動維護。
  • 支援以 Git 為基礎的發布與同步,包括 GitHub Actions 與 CLI 工作流程。
  • 依產品而定,同時提供代管與本機/離線優先的使用模式。
  • 在文件之外,也提供語言特定的 SDK 產生與 API 測試工具。

Cons

  • 價格與功能會因產品與方案而異,因此團隊在採用前需要仔細選擇功能。
  • 部分功能只在公開頁面中以高層次方式描述,因此實作細節可能需要查看個別產品文件。

FAQ

Scalar Docs 是用來做什麼的?

Scalar Docs 用於使用 Markdown、MDX、OpenAPI、AsyncAPI 與雙向 Git 同步來建立並發布開發者文件。它支援預覽、GitHub Actions,以及透過 CLI 發布。

有免費方案嗎?

是的。定價頁面列出一個免費方案,包含代管的 OpenAPI 文件與內建 API 用戶端,也有適用於 Docs、SDK、MCP servers 與 developer portals 的付費方案。

Scalar SDKs 可以產生什麼?

Scalar SDKs 會根據 OpenAPI 文件產生具型別安全的用戶端函式庫。入門頁面提到 TypeScript、Python、CLI 目標,以及更多支援的語言。

Scalar API Client 支援哪些平台?

Scalar API Client 可在瀏覽器中使用,也提供 macOS、Windows 與 Linux 的桌面應用程式。它以 OpenAPI 匯入、collections、environments,以及請求/回應測試為核心。

Scalar 支援哪些標準?

來源內容強調其支援 OpenAPI 與 AsyncAPI 的文件功能、基於 OpenAPI 的 SDK 產生,以及原生支援 OpenAPI 的 API 用戶端與 registry。定價頁面也提到 registry 中支援 JSON Schema。

Quick Facts

類別
開發者工具
主要網域
scalar.com
主要標準
OpenAPI, AsyncAPI, JSON Schema
存取模式
代管、CLI、瀏覽器與桌面應用程式選項
主要使用者
API 團隊、開發者與文件團隊
產品家族
Docs、SDKs、API Client、Registry、MCP/Agent