前后端分离必备，swagger教程

最新推荐文章于 2024-09-19 19:36:22 发布

沉默寡言的托马斯

最新推荐文章于 2024-09-19 19:36:22 发布

阅读量1.2k

点赞数 3

分类专栏： springboot 文章标签： spring boot swagger

本文链接：https://blog.csdn.net/asenseof/article/details/106423562

版权

本文档详细介绍了如何在Spring Boot项目中集成Swagger，包括创建项目、添加依赖、配置Swagger以及编写接口。Swagger不仅自动生成API文档，还支持在线测试，为前后端分离的开发提供了便利。

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

现在的项目是前后端分离，用的是swagger，我抱着学习的心态学习了下

1. 为什么要用swagger

提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

2.创建一个springBoot项目

通过idea创建的，使用的是jdk1.8，springBoot 2.3.0
我das
命名的话，根据自己的喜好命名，点击next
在这里插入图片描述
选择spring web，继续next

最后点击Finsh，一个springBoot项目就创建好了。接下来要在pom里面添加swagger的依赖。

3.配置swagger

在pom.xml里面添加swagger-bootstrap-ui的依赖

        <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>
                <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

在这里插入图片描述
这样依赖就加好了，如出现依赖没有导入，依次点击clean，install，最后点击刷新按钮

接下来依次添加3个文件夹，controll，model，config。

然后再配置创建一个Swagger的配置类，放在config文件夹里

package org.java.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders