宋子宪博客

Spring Boot2.4整合Swagger3.0

Swagger都是直接通过依赖springfox-swagger、springfox-swagger-ui两个jar包来实现的,官方推出了springfox 3.0.0版本已经有了自己的SpringBoot Starter,使用起来更契合SpringBoot项目
使用官方Starter,只需简单的两步就能搞定
在pom.xml中添加springfox官方Swagger依赖

<!--springfox swagger官方Starter-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

添加Swagger的Java配置,配置好Api信息和需要生成接口文档的类扫描路径即可;

/**
 * <p>
 * Description:
 * </p>
 *
 * @author songzixian
 * @version v1.0.0
 * @create 2020-11-27 9:39
 * @see com.greatdata.configuration
 */
@Configuration
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.songzixian.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("宋子宪博客")
                .description("songziixan.com")
                .contact(new Contact("szxblog", null, null))
                .version("V1.0")
                .build();
    }
}

配置后重启项目访问:http://localhost:8080/swagger-ui/

当前页面是本站的「Google AMP」版。查看和发表评论请点击:完整版 »