浅谈springfox-swagger原理解析与使用过程中遇到的坑-创新互联

swagger简介

创新互联-专业网站定制、快速模板网站建设、高性价比错那网站开发、企业建站全套包干低至880元,成熟完善的模板库,直接使用。一站式错那网站制作公司更省心,省钱,快速模板网站建设找我们，业务覆盖错那地区。费用合理售后完善，十载实体公司更值得信赖。

swagger确实是个好东西，可以跟据业务代码自动生成相关的api接口文档，尤其用于restful风格中的项目，开发人员几乎可以不用专门去维护rest api，这个框架可以自动为你的业务代码生成restfut风格的api，而且还提供相应的测试界面，自动显示json格式的响应。大大方便了后台开发人员与前端的沟通与联调成本。

springfox-swagger简介

签于swagger的强大功能，java开源界大牛spring框架迅速跟上，它充分利用自已的优势，把swagger集成到自己的项目里，整了一个spring-swagger，后来便演变成springfox。springfox本身只是利用自身的aop的特点，通过plug的方式把swagger集成了进来，它本身对业务api的生成，还是依靠swagger来实现。

关于这个框架的文档，网上的资料比较少，大部分是入门级的简单使用。本人在集成这个框架到自己项目的过程中，遇到了不少坑，为了解决这些坑，我不得不扒开它的源码来看个究竟。此文，就是记述本人在使用springfox过程中对springfox的一些理解以及需要注意的地方。

springfox大致原理

springfox的大致原理就是，在项目启动的过种中，spring上下文在初始化的过程，框架自动跟据配置加载一些swagger相关的bean到当前的上下文中，并自动扫描系统中可能需要生成api文档那些类，并生成相应的信息缓存起来。如果项目MVC控制层用的是springMvc那么会自动扫描所有Controller类，跟据这些Controller类中的方法生成相应的api文档。

因本人的项目就是SpringMvc，所以此文就以Srping mvc集成springfox为例来讨论springfox的使用与原理。

SpringMvc集成springfox的步骤

首先，项目需要加入以下三个依赖：

   

     org.springframework

     spring-webmvc

     4.2.8.RELEASE

   



   

     io.springfox

     springfox-swagger2

     2.6.1

   

   

   

     io.springfox

     springfox-swagger-ui

     2.6.1

   

当前题目：浅谈springfox-swagger原理解析与使用过程中遇到的坑-创新互联
标题来源：http://bjjierui.cn/article/cocsoh.html