Springboot集成Swagger2,knife4j

文章介绍了如何通过在Springboot项目中集成Swagger2和knife4j来创建简洁易用的本地接口文档,便于接口测试和前后端协作。主要步骤包括添加相关依赖,配置自定义Docket,指定扫描的包路径,以及在Controller中使用注解进行详细说明。
摘要由CSDN通过智能技术生成

为方便本地接口测试和前后端联调,生成简洁易用的接口文档,可通过Springboot集成

Swagger2和knife4j,这比Swagger官方提供的框架更加好用。

1、pom引入以下2个依赖。

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-ui</artifactId>
    <version>3.0.3</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>

2.代码配置,在工程config包下,新建一个配置类,名称随意。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.otitan.swa.controller"))//扫描的包路径
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("泰坦尼克号接口文档")
                .version("otitan:1.0.0")
                .build();
    }
}

3.启动工程 访问接口文档 localhost:port/doc.html。(当然在controller类中加入swagger相关的注解,主要是类上加@Api(tags={"xxx接口"}),方法上加@ApiOperation("xxxx查询")

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值