前后端分离时代--Swagger接口文档的配置与使用

本文详细介绍如何在Spring Boot项目中集成Swagger,实现API文档的自动化生成与管理,包括依赖引入、基本配置及多组接口展示的方法。

在前后端分离的时代,前端开发人员和后端开发人员的沟通显得尤为重要。如果不能做到及时有效的沟通,可能导致后端开发出来的接口,前端人员无法使用,从而导致后端开发人员不得不返工,甚至延长开发周期。
在了解swagger之前我写好接口都是写一个txt文件,把接口地址,以及传参,返回数据都写好后再给前端人员。这样做是可以做到有效的沟,但还是显得有点麻烦,直到我了解了swagger。
知道swagger的人想必一定知道swagger能够干什么吧,不知道的自行百度。
下面我们就开始准备着手搭建swagger环境。
1、新建一个springBoot项目

项目建成之后写一个controller,保证项目能够正常启动并成功访问。

2、swagger依赖

        <!--集成swagger-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.0.RELEASE</version>
        </dependency>

我用的是speingBoot集成的swagger插件,当然你们也可以去maven找纯净的swagger依赖,但是注意别忘了导入swagger-UI的依赖。

3、依赖导入后我们需要启用swagger。
如果你想尽快使用swagger,不想过多了解swagger的配置属性,你可以直接在springBoot的启动类上加入@EnableSwagger2Doc注解,这样你启动项目后就可以通过http://localhost:8080/swagger-ui.html访问到swagger界面啦。

@SpringBootApplication
@EnableSwagger2Doc
public class Swagg
评论 2
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Silence-wen

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值