使用Swagger自动生成文档

最新推荐文章于 2026-07-16 00:00:00 发布

原创

最新推荐文章于 2026-07-16 00:00:00 发布 · 9.1k 阅读

收录于

当前文章被以下社区和专栏收录：

Swagger是一个规范和框架，用于生成、描述RESTful Web服务。Springfox基于Swagger，能够将Controller方法转化为文档，方便API的展示和调用。通过官网和开源地址可以了解更多关于Swagger和Springfox的信息。

Swagger 是什么？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

Springfox 的前身是 swagger-springmvc，是一个开源的 API doc 框架，可以将我们的 Controller 的方法以文档的形式展现，基于 Swagger。

官网：http://swagger.io/

开源地址：http://springfox.github.io/springfox/

Swagger使用

第一步：导入依赖

<!-- Swagger -->
<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>

第二步：开启