知识卡片

Swagger解决的前后端协作问题

专业/工作 · 620.d

内容

前后端分离架构下,接口文档承担着协作契约的作用:项目初期帮前端理解接口能力,项目后期帮维护者回溯接口行为,但手写文档最大的痛点是极易与代码实现脱节——改了接口却忘了同步文档。Swagger(后并入OpenAPI规范)的解法是把文档生成这件事和代码耦合在一起:开发者通过注解在代码里描述接口的用途、参数、返回结构,工具在运行时直接扫描这些注解动态生成可交互的文档页面,文档与代码永远同步,因为文档本身就是代码的一部分。发散:这类”文档即代码”(Docs as Code)的思路后来在很多领域被复用,核心洞察是——只要文档和实现是两份独立维护的东西,就一定会漂移,唯一稳定的解法是让文档从实现里自动派生。

参考来源

《Spring Boot应用开发实战》第3章《创建RESTful Web服务》