[Java知识库]新版springboot整合swagger

网上的教程要么太老要么太奇怪所以这里自己写一个仅供参考的教程
首先是项目所需的包

    <!--swagger-->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>

    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.9.2</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.10.1</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.10.1</version>
    </dependency>

    <dependency>

      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>2.10.1</version>
    </dependency>

最后三个包实际上与swagger无关,但是由于spring4往后就不支持此依赖所以我们需要进行添加
然后添加springboot-web的启动依赖

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <version>2.5.4</version>
</dependency>

创建启动类

package com.test;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author jhx
 * @since 2021/9/23
 */
@SpringBootApplication
@EnableSwagger2
public class Application {

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }
}

然后增加配置文件

package com.test.conf;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author jhx
 * @since 2021/9/25
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

  @Bean
  public Docket webApiConfig() {

    return new Docket(DocumentationType.SWAGGER_2)
        .groupName("webApi")
        .apiInfo(webApiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.test.controller"))
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo webApiInfo() {

    return new ApiInfoBuilder()
        .title("网站-课程中心API文档")
        .description("本文档描述了课程中心微服务接口定义")
        .version("1.0")
        .contact(new Contact("jhx", "http://localhost.com", "test@qq.com"))
        .build();
  }
}

启动以后swagger会扫描com.test.controller目录然后查找我们的接口.
(@Api等注解这里不做说明请查看官方的文档swagger官网)