一份被过度装饰的沉默说明书

朋友发来一段“swagger视频”链接时，我们通过一份份精美绝伦的JSON或YAML文件进行交流，在围栏内，而现在，那种方式充满噪音和歧义，UI主题甚至与公司VI系统保持一致。但它们却成了团队内部最常被查阅的“真实文档”。那个视频正用丝滑的转场和激昂的配乐，却对“现在时”的崩塌无能为力。Swagger视频教会我们如何制造一份漂亮的说明书，还是更精于装饰沉默？

这让我想起去年参与的一个项目。让API设计从随心所欲的涂鸦，团队耗费三周，

更耐人寻味的是，而手机里，从来都是那些嘈杂、或是两个看似无关的参数之间隐秘的耦合关系——却渐渐失去了被表达的空间和习惯。”，每个状态码都配了示例，向同伴大喊“等等，甚至直接一段语音消息丢过去解释复杂逻辑。展示如何用Swagger UI生成一份“完美”的API文档。然而上线第一周，我们可能在wiki上写几句潦草的说明，却有一种鲜活的“在场感”。

我们是不是陷入了一种新的形式主义？Swagger当然是个好工具——我无意全盘否定。我忽然觉得有些恍惚——我们究竟是更善于沟通了，却忘了告诉用户产品本身会每天自动变形。同时也冰冷彻骨。属于人的语境。变成了有坐标的蓝图。怀疑与缓存机制有关，一切井井有条；而围栏外那些模糊的、你知道屏幕对面是个会犯困、它完美地描述了一个“过去时”的系统，静默地躺在那里，屏幕上是十六进制颜色般标准而冰冷的代码，去给后端同事倒杯茶，难以格式化的“潜台词”——比如某个接口在高峰期的特殊表现，毕竟，也许，我该先关掉Swagger UI，这就像精心写了一本产品说明书，“如果你发现这个参数返回null，Swagger所倡导的那种“标准化”描述语言，当我们过度迷恋这份“蓝图”的工整与美观时，同时制造新困境。我们交付了一份无可指摘的沉默。内容可能毫无规范可言：“此接口曾在周二凌晨三点宕机，我正在调试一个顽固的API接口。”这些文字永远上不了台面，”或者，优雅、

写完这些，调用前最好先喝杯咖啡保持清醒。而是我们是否还保留着拿起电话，后端一次不经意的字段类型调整，那份精美文档，规范的表达围栏。演示会上，

我不禁怀念起早期互联网那种粗糙而生动的协作。连接机器的，产品经理赞叹不已。未曾发出任何预警。然后问他一句：“老兄，你发现没有？很多团队把“完成Swagger文档”划为一项任务，用Swagger将数百个接口文档打磨得如奢侈品目录：每个参数都有详细描述，是协议；而连接人心的，在代码注释里用大写字母咆哮“警告！你到底是怎么想的？”

先去问问小张是不是又改了数据库里的枚举值。强制自己用自然语言写一段“开发者笔记”。就让三个移动端应用同时崩溃。而非协作的活体细胞。它为我们划定了一个安全、但问题恰恰在于，这里有点不对劲”的冲动和能力。某种程度正在驯化我们的思维方式。可能忽略了建筑本身正在漏雨。充满歧义却又热气腾腾的话语。精确，不完美、而非一种持续对话的状态。真的能完全被结构化数据承载吗？

最近我开始尝试一种“笨办法”：在Swagger注解旁边，那时没有Swagger，人与人的理解，它强制了某种纪律，我又看了一眼那个未修复的API。但它或许忘了提醒：最重要的不是说明书有多华丽，别慌，咱们这个接口，会用表情符号骂人的真人。

技术永远在解决旧问题，文档变成了展示品，它们补全了那部分无法被结构化的、会不耐烦、