前后端经常为接口文档的一致性头疼，抱怨接口描述总是落后实际代码更新，这问题得解决了。为了让接口文档能与代码同步，我们可以使用 Swagger 来规范接口定义。Swagger 能通过 YAML 或 JSON 生成接口元数据，再利用它的工具链自动生成 Postman 集合、OpenAPI 规范文档、客户端 SDK 和服务端骨架代码。 给这个解决方案加上 Springfox，就可以直接用 Java 生态来解决难题了。Springfox 能自动扫描项目中的 @RestController 和 @RequestMapping 注解，然后把最新的 YAML 文件自动生成出来。把 YAML 文件同步到代码库后，前端和后端都可以使用这个文件，并且根据谁修改了代码谁就提交 PR 的方式更新 YAML。 这种方法让接口文档不再是写完项目就丢在一旁的附属品，而是与代码紧密关联的孪生兄弟。Swagger 让大家摆脱了手动维护 YAML 的烦恼，还省去了大量重复劳动，省下的时间足够你多喝两杯咖啡了。 这样一来，大家再也不需要纠结于更新文档还是更新代码了。把 Swagger 加入到你的项目中吧。