一、文章说明
本文由我亲自搭建,搭建过程中出现过各种错误,百度了一大堆教程都没能解决,最后,只能去官网翻资料,加上公司项目的使用结合,终于搭建出来,如果在搭建有新的问题,欢迎与我讨论。
在你看本文章时,有些情况你必须了解清楚,本文章所写的Swager项目的搭建仅在本文所示例的环境,包括不限于JDK版本、依赖库版本等等。还有个前提,需要说明,在配置Swagger项目时,前提是你的Web项目已经可以正常启动且可以访问,如果不能,请先搭建一个可以正常访问的Web应用。另外,本文搭建Swagger不需要下载Swagger的UI资源(依赖jar中已经包含),可省去很多复杂步骤,话不多说,一起来搭建一个自己的Swagger吧!
二、Swagger搭建步骤
环境说明:
一个可以正常访问的Web应用,并且必须是Spring + Spring MVC整合的项目;
必须是Maven构建的项目;
本文使用JDK 1.8;
搭建步骤
- 在pom.xm中引入Swagger需要的相关依赖
<!-- swagger-springmvc -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
<!-- 除此之外,我们还需要jackson,我使用的是 2.5.0 版本-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.module</