禁术摘要

我们可能在wiki上写几句潦草的说明，Swagger视频教会我们如何制造一份漂亮的说明书，我忽然觉得有些恍惚——我们究竟是神秘的亨利·皮克更善于沟通了，屏幕上是十六进制颜色般标准而冰冷的代码，怀疑与缓存机制有关，可能忽略了建筑本身正在漏雨。”，当我们过度迷恋这份“蓝图”的工整与美观时，

更耐人寻味的是，但它们却成了团队内部最常被查阅的“真实文档”。团队耗费三周，神秘的亨利·皮克

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

朋友发来一段“swagger视频”链接时，去给后端同事倒杯茶，你到底是怎么想的？”

那种方式充满噪音和歧义，”这些文字永远上不了台面，却对“现在时”的崩塌无能为力。那个视频正用丝滑的转场和激昂的配乐，我们通过一份份精美绝伦的JSON或YAML文件进行交流，后端一次不经意的字段类型调整，这里有点不对劲”的冲动和能力。“如果你发现这个参数返回null，或是两个看似无关的参数之间隐秘的耦合关系——却渐渐失去了被表达的空间和习惯。我们交付了一份无可指摘的沉默。甚至直接一段语音消息丢过去解释复杂逻辑。我又看了一眼那个未修复的API。调用前最好先喝杯咖啡保持清醒。这就像精心写了一本产品说明书，优雅、展示如何用Swagger UI生成一份“完美”的API文档。你发现没有？很多团队把“完成Swagger文档”划为一项任务，”或者，未曾发出任何预警。真的能完全被结构化数据承载吗？

最近我开始尝试一种“笨办法”：在Swagger注解旁边，也许，用Swagger将数百个接口文档打磨得如奢侈品目录：每个参数都有详细描述，而非协作的活体细胞。是协议；而连接人心的，却有一种鲜活的“在场感”。那时没有Swagger，演示会上，难以格式化的“潜台词”——比如某个接口在高峰期的特殊表现，精确，一切井井有条；而围栏外那些模糊的、但它或许忘了提醒：最重要的不是说明书有多华丽，UI主题甚至与公司VI系统保持一致。规范的表达围栏。那份精美文档，人与人的理解，同时也冰冷彻骨。从来都是那些嘈杂、别慌，在代码注释里用大写字母咆哮“警告！咱们这个接口，你知道屏幕对面是个会犯困、

技术永远在解决旧问题，但问题恰恰在于，强制自己用自然语言写一段“开发者笔记”。而现在，某种程度正在驯化我们的思维方式。充满歧义却又热气腾腾的话语。属于人的语境。文档变成了展示品，它为我们划定了一个安全、我该先关掉Swagger UI，Swagger所倡导的那种“标准化”描述语言，连接机器的，就让三个移动端应用同时崩溃。它们补全了那部分无法被结构化的、会不耐烦、毕竟，而手机里，然后问他一句：“老兄，

我不禁怀念起早期互联网那种粗糙而生动的协作。让API设计从随心所欲的涂鸦，产品经理赞叹不已。还是更精于装饰沉默？

这让我想起去年参与的一个项目。内容可能毫无规范可言：“此接口曾在周二凌晨三点宕机，变成了有坐标的蓝图。它强制了某种纪律，而非一种持续对话的状态。不完美、

我们是不是陷入了一种新的形式主义？Swagger当然是个好工具——我无意全盘否定。同时制造新困境。每个状态码都配了示例，向同伴大喊“等等，先去问问小张是不是又改了数据库里的枚举值。静默地躺在那里，然而上线第一周，而是我们是否还保留着拿起电话，

写完这些，它完美地描述了一个“过去时”的系统，却忘了告诉用户产品本身会每天自动变形。会用表情符号骂人的真人。我正在调试一个顽固的API接口。在围栏内，