总结 : SpringBoot 项目中使用Swagger2

本文总结了在SpringBoot项目中如何使用Swagger2来创建接口文档。首先,需要在pom.xml中引入Swagger2的依赖,然后在启动类上添加相应注解以启用Swagger。如果要排除BaseController等不必要信息,可以通过配置类进行过滤。最后,文中提到了两种方法处理特殊需求,如全局设置必填参数和接口层面添加请求头参数。
摘要由CSDN通过智能技术生成

在springboot项目中想使用swagger2作为接口查看文档:

1. 使用的jar包 :在pom.xml文件中 引入下面的依赖

<!--引入Swagger2的依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

2. 在启动类上面添加下面的注解,此时就可以打开 链接 http://127.0.0.1:8081/swagger-ui.html#/

@EnableSwagger2

3.但是经过前两步骤之后 在swagger页面会出现 BaseController 等不必要信息,则可以在代码中写一个配置类,将其过滤掉:

/**
 * 此配置文件:
 * 解决访问swaggerUI接口文档显示basic-error-controler
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值