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

最新推荐文章于 2020-12-04 09:59:53 发布

weixin_34284188

最新推荐文章于 2020-12-04 09:59:53 发布

阅读量151

点赞数

文章标签：测试 java python

原文链接：https://my.oschina.net/u/2563693/blog/687947

版权

2019独角兽企业重金招聘Python工程师标准>>>

概述

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之后的版本包路径不一样的，因为工作中使用的spring mvc版本为3.2.5，所以决定使用 0.8.8版本。其他版本的可以使用以上两个网站查找。

依赖

compile "com.mangofactory:swagger-springmvc:0.8.8"
compile 'org.ajar:swagger-spring-mvc-ui:0.2'

配置

配置分两部分，在xml中

<bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
   
   <bean class="org.my.swaggerconfig.SwaggerConfig" />

   <mvc:resources mapping="*.html" location="/" />
   <mvc:default-servlet-handler />

java SwaggerSpringMvcPlugin文件

@Configuration
@EnableSwagger
public class SwaggerConfig {
   private SpringSwaggerConfig springSwaggerConfig;

   /**
   * Required to autowire SpringSwaggerConfig
   */
   @Autowired
   public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
   this.springSwaggerConfig = springSwaggerConfig;
   }

   /**
   * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc framework - allowing for multiple
   * swagger groups i.e. same code base multiple swagger resource listings.
   */
   @Bean
   public SwaggerSpringMvcPlugin customImplementation(){
   return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
   .includePatterns(".*.*");
   }
}