SpringBoot整合Swagger生成接口文档

最新推荐文章于 2025-09-18 13:39:33 发布

原创

最新推荐文章于 2025-09-18 13:39:33 发布 · 885 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#SpringBoot #Swagger

引入

现在的项目大多数都是前后端分离，所以对于后端开发，我们需要一个接口工具帮我们进行接口的整理、也方便我们测试。推荐postMan和Swagger形式，然后postMan需要自己手写接口，然后参数需要手动粘贴，但是相比于它，Swagger就相对方便很多了，他会根据后台的代码，然后自动生成接口以及参数名。

应用

在pom.xml中引入相应的依赖jar包
配置Swagger2配置文件`

@Configuration
@EnableSwagger2
public class Swagger2 {

@Bean
public Docket createRestApi(){
    return  new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.ten.base.controller"))
            .paths(PathSelectors.any()).build();
}


private ApiInfo apiInfo(){
    return  new ApiInfoBuilder().title("Springboot-api文档")
            .description("").termsOfServiceUrl("")
            .version("1.0").build();
}

}`
注意:需要将下面红框中改成自己的的controller路径，否则swagger页面