Findings24Findings24
Scalar logo

Scalar

认领

Scalar 是一个面向 API 文档、SDK 生成、API 测试和注册表工作流的开发者平台，基于 OpenAPI 等开放标准，帮助团队编写文档、生成客户端库，并在 Git、托管、浏览器和桌面流程中保持接口同步。

AI开发者工具AI API设计开发者文档生成器
访问网站
Scalar preview

面向 API 文档、SDK 和客户端的开发者工具

Scalar 是一个面向 API 文档、SDK 生成、API 测试和 API 注册表工作流的开发者平台。该网站将其定位为“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 描述、组织集合、运行请求脚本并验证响应。

API 注册表

借助深度 Git 集成、CI/CD 工作流以及面向注册表的发布方式来管理 OpenAPI 文档，适合需要版本化 API 资产的团队。

团队使用 Scalar 的常见方式

  • 发布开发者文档

    使用 Docs 通过 Markdown 或 MDX 编写指南，将其与 API 参考结合，并从 GitHub 或 CLI 发布，同时让站点与仓库保持同步。

  • 从 OpenAPI 生成客户端库

    使用 SDK 生成将 OpenAPI 文档转为类型安全的客户端库或 CLI，然后在 API 规范变更时管理更新。

  • 交互式测试 API

    使用 API Client 导入 OpenAPI 描述、发送请求、组织集合，并添加请求前或响应后脚本进行测试。

  • 在注册表中管理 API 定义

    使用注册表工作流通过 Git 集成和 CI/CD 自动化来管理和版本化 OpenAPI 文档，适合维护共享 API 资产的团队。

  • 跨团队协调 API 工作流

    使用托管和基于浏览器的工具在需要文档、客户端访问或预览部署的团队之间协作，而无需分别构建每个部分。

Pros and Cons

Pros

  • 一个产品家族覆盖多种 API 工作流，包括文档、SDK、API 客户端和注册表。
  • 围绕 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 服务器和开发者门户的付费方案。

Scalar SDK 可以生成什么？

Scalar SDK 可从 OpenAPI 文档生成类型安全的客户端库。入门页面提到了 TypeScript、Python、CLI 目标以及更多受支持的语言。

Scalar API Client 支持哪些平台？

Scalar API Client 可在浏览器中使用，也提供适用于 macOS、Windows 和 Linux 的桌面应用。它围绕 OpenAPI 导入、集合、环境以及请求/响应测试构建。

Scalar 支持哪些标准？

来源中强调了用于文档的 OpenAPI 和 AsyncAPI 支持、基于 OpenAPI 的 SDK 生成，以及原生支持 OpenAPI 的 API 客户端和注册表。定价页面还提到注册表支持 JSON Schema。

Quick Facts

类别
开发者工具
主要域名
scalar.com
主要标准
OpenAPI、AsyncAPI、JSON Schema
访问方式
托管、CLI、浏览器和桌面应用选项
主要用户
API 团队、开发者和文档团队
产品家族
Docs、SDKs、API Client、Registry、MCP/Agent