夜雨聆风
还在用swagger写文档?太丑了,试试这个颜值工具
还在用swagger写文档？太丑了，试试这个颜值工具
还在用 Swagger UI 写 API 文档？界面像 2011 年遗留系统？别急，今天介绍的 Scalar，或许能让你文档写得比代码还漂亮。
#scalar #接口文档 #Swagger #OpenAPI #科技下一站
软件简介
Scalar 是一个开源的 API 平台，致力于打造“开发者友好”的 API 文档和客户端工具。它既可以作为 Swagger/OpenAPI 文档的渲染界面，也能作为 API 测试工具（类似 Postman），还内置 Mock Server、SDK 生成器、OpenAPI 编辑器等功能，一站式搞定文档管理。
简单点说：Scalar = Swagger UI + Postman + 文档托管 + 插件系统 + CLI + …
目前已被多个主流框架内置支持，比如 FastAPI、Elysia、Hono、Litestar 等。社区活跃、UI 清爽、功能现代，是开发者理想的文档搭子。
软件特点
Scalar 的杀手锏在于“又美又能打”，具体有哪些技能？一起来看：
-
• 交互式 API Reference
支持完整 OpenAPI/Swagger 文档展示，自动生成代码示例，支持主题切换、深色模式，关键是颜值高！ -
• 离线优先 API Client
类似 Postman 的使用体验，但支持本地部署，还能离线使用。不用注册账号就能开始测试接口，体验非常丝滑。 -
• 多语言代码片段自动生成 
支持 curl、Python、JavaScript、Go、C# 等几十种语言自动生成请求代码示例。 -
• Watch 模式与框架集成
支持与后端框架自动同步文档变更，支持如 Hono、Fastify、NestJS、Laravel 等主流后端框架的集成。 -
• 高度自定义
支持插入自定义 Header、Markdown 文档扩展、插件机制等，可根据团队需求定制风格。 -
• 免费托管服务
提供免费子域名托管xxx.apidocumentation.com，支持 GitHub 同步、多人协作等。 -
• 插件与框架支持广泛
一套文档可以嵌入 Vue、React、Astro、SvelteKit、Docusaurus 甚至 .NET、SpringBoot、Flask 等任意项目。
技术架构
Scalar 是一个典型的前后端分离架构项目，核心使用 TypeScript + Vue 开发，CLI 工具也基于 Node.js 打造，支持多平台运行：
-
• 前端：Vue3 + Vite，支持 CDN 引入，也可自定义构建主题。 -
• 后端/CLI：Node.js 构建，可生成 SDK、Mock Server、Markdown 文档。 -
• 部署方式：本地 HTML 嵌入、Docker、自托管、Nginx、托管服务全支持。 -
• 开源许可：MIT 许可证，放心商用，随便魔改。
快速使用（只需一个 HTML 文件）
<!doctype html>
<html>
<head>
<title>My API Reference</title>
<meta charset="utf-8" />
</head>
<body>
<div id="app"></div>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
<script>
Scalar.createApiReference('#app', {
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
proxyUrl: 'https://proxy.scalar.com',
})
</script>
</body>
</html>一句话总结：复制这段代码，你的 API 文档就上线了！
推荐理由总结
如果你想找一款：
-
• 替代 Swagger UI 的高颜值 API 文档工具 -
• 本地部署、自定义 UI、可离线使用的 Postman 替代品 -
• 能一键生成代码、文档、Mock Server 的开发套件
那 Scalar 可以说是 “开箱即用 + 持久美观 + 高度自由” 的首选。
项目地址
项目主页：
👉 https://scalar.com
GitHub 开源仓库：
👉 https://github.com/scalar/scalar
结语
有了 Scalar，文档不再是枯燥的说明书，而是开发流程中最“有型”的部分。
别再手撸 Swagger JSON，也别在 Postman 里点来点去了，给自己一个更聪明的工具 —— Scalar！
如果你觉得这个工具还不错，欢迎点个赞、分享给你的后端小伙伴！
