SpringBoot整合Swagger文档介绍

本文详细介绍了如何在SpringBoot项目中集成Swagger,包括导入依赖、配置文件及解决权限拦截问题,帮助开发者快速上手,实现API文档自动生成及在线测试。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

SpringBoot整合Swagger文档

springboot整合swagger步骤如下

1.导入依赖

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

2.添加swagger配置文件

@Configuration
@EnableSwagger2
public class Swagger2Config {

}

3.如果项目中使用权限拦截,一并对swagger放行

.excludePathPatterns("/swagger-ui.html")
.excludePathPatterns("/v2/**")
.excludePathPatterns("/swagger-resources/**")

注意:这里在controller类添加注解如果扫描不到也无法使用

正常配置完swagger以后 进入swagger-ui界面,swagger-ui界面可以用来测试接口,和查看api接口信息默认扫描所有api接口 显示配置成功后
在这里插入图片描述

展开hello-controller的hello接口,输入参数并点击执行,就可以看到接口测试结果了
在这里插入图片描述
完成之后再次启动应用就可以看到结果了
以上就是我分享的soringboot集成swagger的内容,和swagger的部分知识点
如果想要了解更多swagger的内容可以去swagger的官网
官网地址:https://swagger.io/

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值