Spring Boot集成Swagger UI

最新推荐文章于 2024-07-27 13:06:23 发布

lcyhshj

最新推荐文章于 2024-07-27 13:06:23 发布

阅读量710

点赞数 1

分类专栏： SpringBoot 文章标签： java

本文链接：https://blog.csdn.net/weixin_50139963/article/details/124289941

版权

本文介绍了Swagger UI的功能，它能根据OpenAPI规范自动生成接口文档，并提供在线预览和测试。接着，文章指导如何在Spring Boot项目中引入Swagger UI依赖，通过配置Swagger Config文件，实现了API接口的可视化管理。读者可以通过访问指定URL来查看和测试接口。

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

一：首先了解一下什么是Swagger UI？
Swagger UI 允许任何人（无论是开发团队还是最终消费者）可视化 API 的资源并与之交互，而无需任何实现逻辑。它是根据您的 OpenAPI（以前称为 Swagger）规范自动生成的，具有可视化文档，便于后端实现和客户端使用。主要作用是：接口的文档在线自动生成和在线预览，可以进行业务功能的测试。目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。

二：引入所需的swgger-ui依赖

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

三：启动类添加开关注解@EnableOpenApi
@SpringBootApplication
@EnableOpenApi
public class SbVueApplication{
   public static void main(String[] args) {
    SpringApplication.run(AutoBrower.class, args);
   }
}

访问地址：（端口号设置自己的） http://localhost:9090/swagger-ui/index.html

四：配置Swagger 编写Config文件
1.首先新建一个