打开网易新闻 查看精彩图片

API文档工具市场有个冷知识:Swagger UI(开放应用程序接口用户界面)在2011年发布,Redoc(一种API文档生成工具)在2016年开源,两者加起来垄断了开发者13年的选择。直到2023年,一个德国团队用18个月做出了Scalar——免费、零依赖、还能直接在线调试接口。GitHub星标数从0到1.2万,他们只花了11个月。

「文档写完就扔」的痛点,被这个团队算准了

「文档写完就扔」的痛点,被这个团队算准了

做过后端开发的都懂:写OpenAPI(开放应用程序接口)规范是体力活,生成文档是技术活,让前端同事愿意看是玄学。Swagger UI解决了"能看",但界面像2005年的政府网站;Redoc解决了"好看",但想测试接口得复制粘贴到Postman(接口测试工具)。

Scalar的解法很直接——把文档和测试工具焊死在一起。左边是接口说明,右边是调试面板,点击"发送"就能看到响应。不用切窗口、不用配环境、不用教前端怎么导入curl(命令行工具)命令。

他们的GitHub仓库里有条issue(问题反馈)很说明问题:「我们团队有3个后端,8个前端。上线Scalar后,前端来Slack(团队协作工具)问接口问题的次数少了70%。」这条反馈被置顶了8个月。

技术实现上,Scalar做了两个反常识的选择。

第一,完全基于Vue(前端框架)3重写渲染层,但打包成Web Component(网页组件)。这意味着你可以把它塞进React(前端框架)项目、Vue项目、甚至纯HTML页面,不会有样式冲突。第二,API客户端不依赖后端代理,直接在浏览器里发请求——靠CORS(跨域资源共享)策略和巧妙的预检请求处理,绕过了传统方案的服务器中转。

代价也有。某些企业内网的严格防火墙会拦截这种直接请求,Scalar的应对是提供可选的代理模式,默认关闭,需要时一键开启。

免费API的算盘:用托管服务养开源项目

免费API的算盘:用托管服务养开源项目

打开网易新闻 查看精彩图片

Scalar的核心代码在GitHub完全开源,MIT协议,随便商用。但他们上个月上线了Scalar Cloud(云平台服务)——托管版的文档生成服务,免费额度足够个人开发者和小团队用。

免费档的具体数字:每月10万次API请求、1GB带宽、3个项目。超出后按量计费,但定价表藏在登录后的控制台里,官网上只写了一句「按需付费,无隐藏费用」。这种藏法很产品经理:先让你用起来,用量上去之后自然知道值多少钱。

他们的商业化路径和Vercel(前端部署平台)很像——开源工具建立信任,云服务转化付费。区别在于,API文档这个品类比前端部署更刚需:每个有接口的团队都需要,但自建文档站的维护成本远高于部署一个静态页面。

Scalar团队目前有7个人,base(基地)在德国柏林。创始人Marvin(马文)之前在Stoplight(API设计工具公司)工作,2023年初离职创业。他在播客里提过离职原因:「Stoplight被收购后,产品方向变成了企业销售驱动。我想做开发者真正每天想打开的工具。」

Scalar的免费API服务有个隐藏设计:自动生成文档的SEO(搜索引擎优化)优化版本。

托管的文档页面会被搜索引擎完整索引,每个接口路径生成独立URL。这对做公开API的创业公司很值钱——你的接口文档本身就是获客渠道。Stripe(支付平台)和Twilio(通信平台)早证明了这一点,但自建同样的SEO架构需要专门的前端团队。

框架适配的速度,暴露了团队的工程能力

框架适配的速度,暴露了团队的工程能力

Scalar的开源仓库里,框架适配包的数量是观察窗口。Express(Node.js框架)、Fastify(Node.js框架)、Hono(轻量级Web框架)、NestJS(企业级Node.js框架)、Django(Python框架)、Laravel(PHP框架)、Spring Boot(Java框架)——主流后端框架全覆盖,每个包的代码量控制在200行以内。

Hono的适配尤其值得说。这个日本团队做的轻量框架去年突然爆火,Scalar在Hono 3.0发布两周后就出了官方适配。对比之下,Redoc至今没有官方Hono集成,社区方案还是实验性质。

打开网易新闻 查看精彩图片

他们的发布节奏也很有意思。每周五发版,版本号严格遵循语义化规范,changelog(变更日志)用AI辅助生成但人工审核。GitHub Discussions(讨论区)里,核心维护者平均响应时间是4小时——这个指标很多10人以上的开源团队都做不到。

CDN(内容分发网络)零依赖版本是另一个技术细节。一行script标签引入,20KB gzipped(压缩后体积),支持所有现代浏览器。这对内部系统很有用:有些企业的IT策略禁止npm(包管理工具)安装,但允许引入外部CDN资源。Scalar把这个场景当成了first-class citizen(一等公民)对待。

主题系统的设计暴露了产品品味。

内置7套主题,从「purple」(紫罗兰)到「kepler」(开普勒)到「saturn」(土星),命名全是天文相关。每套主题不是换色那么简单,包括代码高亮方案、响应示例的折叠动画、甚至错误状态的微交互。开发者可以覆盖任意CSS(层叠样式表)变量,文档里直接给了设计令牌(design token)清单。

一个被低估的功能:自动生成代码示例。选中任意接口,右侧调试面板会实时生成curl、Python requests、JavaScript fetch等9种语言的调用代码。这些代码不是模板填充,而是根据你的实际参数动态生成——改了查询参数,代码同步变。

Scalar的路线图在GitHub Projects(项目管理工具)里公开。Q2的重点是团队协作功能:评论、版本对比、变更通知。Q3有计划接入AI生成接口描述——不是替代人工写文档,而是根据代码注释自动补全缺失的字段说明。

他们的竞争对手也在动。Swagger母公司SmartBear(软件公司)去年推出了SwaggerHub的新版本,界面明显向Scalar靠拢;Redocly(Redoc的商业化公司)则在推自己的托管服务,定价策略和Scalar Cloud几乎镜像。

但Scalar有个时间窗口优势:开发者对API工具的审美已经被养刁了。2024年的新团队选型,默认会对比「能不能在线调试」「主题好不好看」「有没有暗黑模式」。这些Scalar全中,而Swagger UI和Redoc的存量用户迁移成本正在累积。

最后说个细节。Scalar的官网文档站,本身就是用Scalar生成的。递归自指, dogfooding(自己吃自己的狗粮)到极致。他们在footer(页脚)里藏了彩蛋:点击版本号会显示构建时的Git commit hash(提交哈希值)和构建时间戳——精确到秒。

这种对细节的执念,可能是德国团队的产品基因。也可能是他们知道,在开发者工具这个赛道,信任的建立靠的不是功能清单,而是每次交互的确定性。

你现在的API文档 workflow(工作流程)是什么?还在用Swagger UI凑合,还是已经切到Scalar这类新工具,又或者干脆手写Markdown(标记语言)?