SpringBoot入门教程三--整合Swagger及Restful Api设计规范

最新推荐文章于 2025-11-16 21:24:56 发布

原创

最新推荐文章于 2025-11-16 21:24:56 发布 · 596 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #swagger #restful #spring

本文介绍如何在SpringBoot应用中整合Swagger，实现API文档的自动化，并遵循Restful API设计规范，包括HTTP请求规范和URL设计。通过 Swagger，开发者可以便捷地调试接口，提高开发效率。

本文4114字，预计阅读11分钟☕

前文导读

SpringBoot入门教程一–快速实现第一个HelloWorld

SpringBoot入门教程二–配置文件及快速启动原理

整合Swagger及Restful Api设计规范

前言

在之前的学习中，无论我们是对第一个“Hello World”还是对自定义参数的接口测试，我们都是通过浏览器地址来访问，这仅限于GET请求，如果是POST或者DELETE请求呢，有小伙本可能会说“我可以用Postman调试”，但是就算是Postman我们也需要手动去输入访问地址，接口多了也很麻烦。
那有小伙伴会问了“说了这么多，你倒是说个解决方案啊？”
别慌，客官里面请，小的马上给您一一道来。

整合Swagger

啥是Swagger

先来看看官网的介(Chui)绍(Bi)：
Swagger官网简介
可以看到官网对Swagger的简介就是为了简化API开发。我们可以借助Swagger自动生成接口文档，不仅我们自己调试接口时极为方便，而且在前端找我们联调时，兄弟你可以直接甩出你的Swagger地址让他自己一边玩儿去。是不是很爽，那我们马上开始。

集成Swagger

引入Swagger依赖：

<!--swagger-->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>