restfull

swagger + spring mvc 实现rest 接口代码与api 同步维护,更新

拟墨画扇 提交于 2019-12-04 03:27:32
概述 swagger 是一个规范和完整的框架,是用来生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。 简单的说,就是将res接口的文档解释和代码更新同步,不需要维护代码和文档,造成api文档跟不上代码的速度,api文档更新不及时,还耗费资源维护。 springfox原理 springfox的原理,是通过解析springmvc的handlerMapping获得接口的信息,生存api文档,使用这种方式不需要太多的学习成本。只需要一些spring 配置即可。开发人员除了一两个注解,不需要了解太多。 swagger springfox基本信息 swagger http://swagger.io/ springfox https://springfox.github.io/springfox/ swagger 可以和很多技术整合在一起,具体的可以在 swagger -tools菜单下面找 http://swagger.io/open-source-integrations/ springfox 原名 swagger-springMvc,在2之前的版本和2之后的版本包路径不一样的