springboot 集成swagger2

最新推荐文章于 2025-11-11 07:15:00 发布

原创最新推荐文章于 2025-11-11 07:15:00 发布 · 228 阅读

0 ·

CC 4.0 BY-SA版权

java 专栏收录该内容

9 篇文章

订阅专栏

本文详细介绍了如何在SpringBoot项目中集成Swagger，包括添加依赖、配置SwaggerConfig、使用注解等步骤，最后通过访问特定URL展示API文档。

一、添加如下依赖：

<!--swagger config -->
<!--引入ui包-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.3</version>
</dependency>

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
   <exclusions>
   <exclusion>
      <artifactId>swagger-models</artifactId>
      <groupId>io.swagger</groupId>
   </exclusion>
   <exclusion>
      <artifactId>swagger-annotations</artifactId>
      <groupId>io.swagger</groupId>
   </exclusion>
</exclusions>
</dependency>

<dependency>
   <groupId>io.swagger</groupId>
   <artifactId>swagger-annotations</artifactId>
   <version>1.5.21</version>
</dependency>
<dependency>
   <groupId>io.swagger</groupId>
   <artifactId>swagger-models</artifactId>
   <version>1.5.21</version>
</dependency>

二、编辑SwaggerConfig:

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("springboot 调用 Azkaban APi")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.javaazkaban.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Azkaban api use")
                .description("Springboot 整合Azkaban")
                .version("1.0")
                .build();
    }
}

三、配置controller上的注解：

@RestController
@RequestMapping("/api/azkaban")
@Api(tags = "Azkaban api use")
public class AzkController{

    @Autowired
    private AzkService azkService;

    @ApiModelProperty(value = "登陆Azkaban")
    @GetMapping("/login")
    public Boolean login() throws Exception {
        return azkService.login();
    }

四、启动程序，访问地址如下：

http://localhost:8080/doc.html