scalar

现代化的OpenAPI/Swagger文档生成与API测试工具

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:scalar。
它的用途是:现代化的OpenAPI/Swagger文档生成与API测试工具
完整的 Skill 内容见:https://321skill.com/skills/scalar/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“帮我看一下这个OpenAPI文件,用Scalar的风格生成一个交互式文档页面。”,它会解析你的YAML/JSON文件,并指导你如何集成Scalar组件到你的项目中,或直接使用其在线编辑器预览。或者

对AI说:“我需要测试这个POST接口,参数是动态的。”,它可以建议你使用Scalar客户端,并说明如何设置环境变量和动态参数。

介绍

Scalar 是一个现代化的 API 开发工具套件,旨在解决传统 API 文档(如 Swagger UI)交互体验陈旧、功能单一的问题。它通过提供美观、交互式的 API 参考文档和功能强大的 API 客户端,提升开发者和团队在 API 设计、文档化和测试环节的效率。

使用 Scalar 非常简单。对于 API 文档,只需将你的 OpenAPI/Swagger 规范文件导入 Scalar 的编辑器或集成到你的 Web 框架中,即可自动生成一个功能丰富、支持实时测试的交互式文档页面。对于 API 测试,你可以下载其桌面客户端或直接在浏览器中使用,导入 API 定义后即可进行请求测试、环境变量管理等操作。

它非常适合后端开发者、API 设计师、全栈工程师以及需要与 API 频繁交互的前端或移动端开发者。无论是个人项目快速生成美观文档,还是团队协作进行 API 设计与测试,Scalar 都能提供出色的支持。

建议在项目初期就引入 Scalar 来定义 API 规范,其“Watch Mode”能实时同步框架代码的变更。对于客户端,可以利用其离线优先的特性,在没有网络的环境下也能进行 API 调试。注意,其高级协作和团队管理功能可能需要订阅付费计划。

核心特点

与同类工具(如 Swagger UI)相比,Scalar 提供了极具现代感的交互界面和内置的、功能完整的 API 测试客户端,实现了文档与测试的无缝融合;同时,它深度集成了数十种主流 API 框架(如 Elysia, Hono, FastAPI),支持“Watch Mode”实时同步,开发体验更流畅。

注意事项

对于只需要极简、无需交互的静态 API 文档生成的场景,Scalar 可能显得功能过于复杂。

常见问题

Scalar 是免费的吗?

核心的 API 参考文档生成器和 API 客户端是开源且免费的,高级团队协作功能需要付费。

Scalar 支持哪些 API 描述格式?

主要支持 OpenAPI (Swagger) 2.0 和 3.x 规范。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/scalar/raw/index.md 读取 scalar 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。