JavaWeb——swagger使用

最新推荐文章于 2025-07-14 10:34:46 发布

原创

最新推荐文章于 2025-07-14 10:34:46 发布 · 1.8k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#swagger #springmvc #java

本文档详细介绍了如何在JavaWeb项目中集成Swagger，解决传统接口文档维护难题。通过添加jar依赖、创建SwaggerConfig配置、引入资源文件、配置SpringMVC及注解控制器，实现程序与文档同步更新。最后展示了访问Swagger UI的效果和可能遇到的问题。

一、引言

在日常工作中，开发人员经常会遇到写接口文档的工作，一般都是word文档，带来书写麻烦、维护麻烦的问题，比如改了源代码忘了更新文档、解释不明确带来歧义、无法在线尝试等等。swagger就是为了解决这些问题而产生的。

swagger可以独立程序以外书写，也可以嵌入在程序里面，程序写完文档就有了，本文使用的是后者。之前写过vs中写过C#的wagger，本篇是java版的。

二、使用教程

1、添加jar依赖

我使用的是maven，如果没使用请手动下载撒==

		<!-- swagger -->
		<dependency>
			<groupId>com.mangofactory</groupId>
			<artifactId>swagger-springmvc</artifactId>
			<version>1.0.2</version>
		</dependency>

2、新建SwaggerConfig类

/**
 * 项目名称：apidoc
 *
 * @description:
 * @author Wind-spg
 * @create_time：2015年2月10日 上午10:27:51
 * @version V1.0.0
 *
 */
@CrossOrigin(origi

最低0.47元/天解锁文章

新学期VIP享超值加赠