Spring Boot集成Swagger+Knife4j一键生成接口文档

2022-12-07 17:08:39

Spring Boot集成了Swagger+Knife4j，一键生成接口文档

简介

在Spring Boot项目中，接口文档对于提高开发效率至关重要。Swagger是一个流行的接口文档生成工具，而Knife4j则是一个基于Swagger的工具，可以创建更美观的文档。本文将详细介绍如何将Swagger和Knife4j集成到Spring Boot项目中，一步步生成美观的接口文档。

Swagger简介

Swagger是一个开源工具，用于生成接口定义文件（通常为JSON格式）。通过解析代码，Swagger可以自动提取接口的信息，如请求参数、响应参数和请求方法等。

Knife4j简介

Knife4j是一个基于Swagger的工具，可以将Swagger生成的接口定义文件转换为更美观、用户友好的文档。Knife4j提供了多种模板，允许您自定义文档的样式和布局。

集成步骤

1. 依赖引入

首先，需要在项目的pom.xml文件中添加以下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-ui</artifactId>
    <version>2.0.7</version>
</dependency>

2. 配置

在Spring Boot的配置类中，需要配置Swagger和Knife4j：

@Configuration
@EnableSwagger2
public class SwaggerConfig {

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("接口文档")
                .version("1.0.0")
                .build();
    }
}

3. 启动类配置

在Spring Boot的启动类中，需要配置Servlet注册，以将Swagger UI映射到特定路径：

@SpringBootApplication
public class DemoApplication {

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

    @Bean
    public ServletRegistrationBean<ApiExplorerServlet> getRegistrationBean() {
        ServletRegistrationBean<ApiExplorerServlet> registrationBean = new ServletRegistrationBean<>(new ApiExplorerServlet());
        registrationBean.addUrlMappings("/swagger/*");
        return registrationBean;
    }
}