Scalar

Scalar 是一个现代化的开源开发者体验平台，专为文档化、测试和发现 API 而设计。它提供了一套全面的工具，可将标准的 OpenAPI/Swagger 文件转换为世界一流的交互式 API 文档。该平台因其强大的功能、灵活性和以开发者为中心的方法而受到从初创公司到财富 500 强企业的广泛用户的信赖。

Scalar 的核心功能是生成美观且功能强大的 API 参考文档。这些文档不是静态的；它们包含一个交互式演练场，允许开发者和用户直接在浏览器中测试 API 端点。这种文档与测试的无缝集成显著缩短了上手时间，并简化了开发工作流程。该平台还包括一个强大的 Swagger 编辑器，使用户能够轻松预览、编辑和管理其 OpenAPI 规范。

如何使用 Scalar

开始使用 Scalar 非常简单。开发者可以首先导入现有的 OpenAPI/Swagger 文件（支持 3.1、3.0 和 2.0 版本），或使用集成的 Swagger 编辑器从头开始创建一个。规范加载后，Scalar 会自动生成交互式文档。

为了将 Scalar 集成到项目中，它为众多框架（如 .NET、Fastify、Next.js、Laravel、Express 等）提供了软件包。通常只需一个简单的命令，例如 dotnet add package Scalar.AspNetCore。然后，开发者可以在其应用程序中添加几行代码，以提供 Scalar API 参考文档。该平台还提供一个独立的、离线优先的 API 客户端，适用于 Web、macOS、Linux 和 Windows，可以独立使用或与文档结合使用，以进行稳健的 API 测试。

Scalar 的核心功能

• 交互式 API 文档： 根据 OpenAPI/Swagger 文件自动生成美观、用户友好的 API 文档，并内置测试演练场。
• 集成 API 客户端： 一个功能强大、离线优先的 REST API 客户端，可在所有主流桌面平台上使用，用于全面的 API 测试和调试。
• Swagger 编辑器： 一个免费的开源工具，可直接在平台内预览、编辑和管理 Swagger/OAS 文件。
• 广泛的定制化： 提供完全的品牌化能力，支持自定义主题、颜色、字体，并能够添加自定义 CSS/JavaScript，即使在免费计划中也是如此。
• 框架集成： 为各种流行的后端框架（包括 .NET、Nitro、FastAPI、Hono、NestJS 等）提供易于使用的软件包。
• Git + Markdown 同步： 允许文档与代码并存，支持用 Markdown 编写并链接到 OpenAPI 文件的文档。
• 开源核心： 由社区构建并为社区服务，确保透明度、持续改进和无厂商锁定。
• 代码示例生成： 自动生成各种流行编程语言的代码示例，以帮助用户使用 API。

Scalar 的使用案例

Scalar 非常适合任何构建、维护或使用 API 的个人或团队。一个主要的使用案例是，公司希望为其公共或内部 API 提供卓越的开发者体验。例如，Supabase、Maersk 和 Tailscale 等公司使用 Scalar 来支持其 API 文档。它也同样适用于需要快速、简便地可视化和测试自己正在开发的 API 的个人开发者。团队可以使用专业版中的协作功能来同步 API 测试工作区，并确保整个开发生命周期的一致性。

Scalar 的优势特点

Scalar 的主要优势在于其将文档和测试无缝集成到一个统一的平台中。与其他将这些功能分开的工具不同，Scalar 允许用户在阅读端点信息后立即进行测试，而无需离开页面。其开源性质和对 OpenAPI 规范的承诺避免了厂商锁定。高度的可定制性使公司能够保持品牌一致性。此外，其离线优先的 API 客户端对于需要在没有持续互联网连接的情况下工作的开发者来说是一个显著的好处。慷慨的免费计划使其对所有人开放，而价格合理的专业版则为专业团队提供了强大的功能。

定价和计划

Scalar 提供灵活的免费增值定价模式：

• 免费计划： 包括 1 个用户、无限工作区、免费子域名 (apidocumentation.com)、API 参考、完整的主题和自定义 CSS/JS 样式，以及内置的 Scalar API 客户端。
• 专业版（每席位每月 12 美元）： 包括免费计划的所有功能，外加自定义域名、与 GitHub 同步、指南与版本管理、高级搜索（由 TypeSense 提供支持）和优先支持。
• 企业版（自定义定价）： 包括专业版的所有功能，外加单点登录 (SSO/SAML)、每月文档审计、已验证的工作区和专属的 Slack 支持渠道。