Scalar

Scalar 是一个用于构建专业且运行流畅的 API 文档的平台。您提供 OpenAPI 文档，Scalar 会将其转换为易于阅读的页面，内置示例和测试工具。

该平台提供多个协同工作的产品。API 参考以简洁的布局展示您的文档。API 客户端允许开发者直接测试端点。平台还包含管理多个 API 文档版本和与 GitHub 同步的工具。

Scalar 完全开源，代码公开且免费使用。您可以自行托管，也可以使用他们的云服务。免费计划涵盖基本功能，付费计划则增加协作工具、自定义域名和更优质的支持。

使用 Scalar 非常简单，无需复杂的设置。以下是入门步骤：

• 访问 Scalar 网站并创建一个免费账户以保存您的工作。您将获得一个免费的子域名，例如 yourname.apidocumentation.com。

• 通过粘贴 URL、上传文件或连接到 GitHub 来上传您的 OpenAPI 文档。Scalar 支持 JSON 和 YAML 格式。

• 选择一个主题并自定义颜色以匹配您的品牌。如果您希望对设计有更多控制，可以添加自定义 CSS。

• 使用编辑器编写额外的指南。这些页面解释了超出自动参考页面的概念。

• 使用内置客户端测试您的 API 端点。点击任何端点，添加参数并发送请求以查看真实响应。

• 与您的团队共享文档或将其公开。您可以设置权限以控制谁可以编辑或查看。

• 从 OpenAPI 文件生成美观的 API 文档

• 内置 API 客户端测试

• GitHub 集成与自动同步

• 自定义域名和主题

• 支持所有主流平台的框架集成

• 基于 TypeSense 的搜索功能

• 支持多版本 API

• Markdown 和 MDX 指南

• 团队协作工具

• 开源且支持自托管

• 包含免费子域名

• 支持自定义 CSS 和 JavaScript