一步步完成Maven+SpringMVC+SpringFox+Swagger整合示例

本文给出一个整合Maven+SpringMVC+SpringFOX+Swagger的示例，并且一步步给出完成步骤。

本人在做实例时发现 http://blog.csdn.net/zth1002/article/details/46927187 中，Spring必须是4.0以上版本。

 

目标

在做项目的时候，有时候需要提供其它平台（如业务平台）相关的HTTP接口，业务平台则通过开放的HTTP接口获取相关的内容，并完成自身业务~

提供对外开放HTTP API接口，比较常用的是采用Spring MVC来完成。

本文的目标是先搭建一个简单的Spring MVC应用，然后为Spring MVC整合SpringFox-Swagger以及SpringFox-Swagger-UI，最终，达到Spring MVC对外开放接口API文档化。

如下图所示：

搭建SpringMVC工程

新建Maven工程

Eclipse中，File --> New --> Maven Project， 

点击“Next”按钮， 然后选择 “maven-archetype-webapp”，

继续点击“Next”按钮，然后指定

点击“Finish” 按钮结束~ 就这样，一个简单的Web工程就建好了~

但是，

默认是使用J2SE-1.5， 配置一下Build Path，使用本地机器上安装的JDK

（本文中使用的是JDK 1.7），工程默认字体是GBK，将其改成UTF-8

完成后，Maven工程的结构如下图所示：

引入Spring依赖包

在本示例中，因为简单，所以只要引入如下几个jar包就好了~

1. <dependencies>

2. <!--引入Spring依赖包 -->

3. <dependency>

4. <groupId>org.springframework</groupId>

5. <artifactId>spring-core</artifactId>

6. <version>${spring.framework.version}</version>

7. </dependency>

8. <dependency>

9. <groupId>org.springframework</groupId>

10. <artifactId>spring-context</artifactId>

11. <version>${spring.framework.version}</version>

12. </dependency>

13. <dependency>

14. <groupId>org.springframework</groupId>

15. <artifactId>spring-webmvc</artifactId>

16. <version>${spring.framework.version}</version>

17. </dependency>

18. </dependencies>

完整的pom.xml文件内容如下：

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

3. <modelVersion>4.0.0</modelVersion>

4. <groupId>com.xxx.tutorial</groupId>

5. <artifactId>springfox-swagger-demo</artifactId>

6. <packaging>war</packaging>

7. <version>0.0.1-SNAPSHOT</version>

8. <name>springfox-swagger-demo Maven Webapp</name>

9. <url>http://maven.apache.org</url>

10.  

11. <properties>

12. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

13. <spring.framework.version>4.3.6.RELEASE</spring.framework.version>

14. </properties>

15.  

16. <dependencies>

17. <!--引入Spring依赖包 -->

18. <dependency>

19. <groupId>org.springframework</groupId>

20. <artifactId>spring-core</artifactId>

21. <version>${spring.framework.version}</version>

22. </dependency>

23. <dependency>

24. <groupId>org.springframework</groupId>

25. <artifactId>spring-context</artifactId>

26. <version>${spring.framework.version}</version>

27. </dependency>

28. <dependency>

29. <groupId>org.springframework</groupId>

30. <artifactId>spring-webmvc</artifactId>

31. <version>${spring.framework.version}</version>

32. </dependency>

33. </dependencies>

34.  

35. <build>

36. <finalName>springfox-swagger-demo</finalName>

37. </build>

38. </project>

39.  

编写spring-mvc.xml文件

1. <?xml version="1.0" encoding="UTF-8"?>

2. <beans xmlns="http://www.springframework.org/schema/beans"

3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"

4. xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:p="http://www.springframework.org/schema/p"

5. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd

6. http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd

7. http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">

8.  

9. <!-- 默认的注解映射的支持 ,它会自动注册DefaultAnnotationHandlerMapping 与AnnotationMethodHandlerAdapter -->

10. <mvc:annotation-driven />

11.  

12. <!-- enable autowire 向容器自动注册 -->

13. <context:annotation-config />

14.  

15. <!-- 设置使用注解的类所在的jar包 -->

16. <context:component-scan base-package="com.xxx.tutorial" />

17. <bean

18. class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" />

19.  

20. </beans>

配置web.xml