springmvc集成swagger实现接口文档自动化生成

最新推荐文章于 2024-08-09 10:02:55 发布

liufei198613

最新推荐文章于 2024-08-09 10:02:55 发布

阅读量1.8w

点赞数

分类专栏： springmvc 文章标签： springmvc swagger 接口文档

本文链接：https://blog.csdn.net/liufei198613/article/details/51801908

版权

本文介绍了如何在SpringMVC项目中集成Swagger，实现接口文档的自动化生成。内容包括Swagger的基本介绍，集成步骤，Swagger-UI的配置，如修改index.html的URL指向，处理静态资源，以及解决汉化、参数Content Type问题的解决方案。

摘要由CSDN通过智能技术生成

一直苦于文档整理工作，因为这是一个很无聊的工作，偶然在网上看到了swagger这东西，感觉不错，于是动手集成了一下，眼前一亮

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

费话少说，下面来看一下集成的过程，我用的环境是：jdk1.8+tomcat7.0+springmvc4.2+maven3.0

1.首先,通过maven将相关的jar引入项目

<!-- swagger -->
		<dependency>
			<groupId>com.mangofactory</groupId>
			<artifactId>swagger-springmvc</artifactId>
			<version>1.0.2</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.dataformat</groupId>
			<artifactId>jackson-dataformat-xml</artifactId>
			<version>2.7.4</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-databind</artifactId>
			<version>2.7.4</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-annotations</artifactId>
			<version>2.7.4</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-core</artifactId>
			<version>2.7.4</version>
		</dependency>
		<!-- swagger -->

2.写一个自定义的swagger的config类

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.models.dto.ApiInfo;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;

/**
 * <B>文件名称：</B>SwaggerConfig.java<BR>
 * <B>文件描述：</B><BR>
 * 
 * <B>版权声明：</B>(C)2014-2015<BR>
 * <B>公司部门：</B><BR>
 * <B>创建时间：</B>2016年6月30日<BR>
 * 
 * @author 
 * @version 
 */
@Configuration
@Enable