knife4j openapi2

### 使用Knife4j与OpenAPI2集成进行接口文档生成

为了实现使用Knife4j与OpenAPI2集成并生成接口文档，在项目配置上需引入特定依赖项。对于Maven构建工具而言，应在`pom.xml`文件内加入如下依赖：

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

<!-- OpenAPI v2 (Swagger 2) dependencies -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

完成上述操作之后，还需通过Java代码进一步配置以支持OpenAPI2标准下的接口文档生成功能。

#### 配置类定义

创建一个新的配置类用于初始化Swagger环境，并指定基本属性如标题、版本号以及联系信息等细节参数设置：

@Configuration
@EnableSwagger2Doc
public class SwaggerConfig {

    @Bean(value = "defaultApi")
    public Docket defaultApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                /* 定义要扫描的基础包路径 */
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("API Title") // API 文档名称
                .description("Description of the APIs.") // 描述
                .contact(new Contact("Name", "", ""))
                .version("1.0")
                .build();
    }
}

此段代码片段展示了如何利用Spring Boot框架中的@Bean注解注册Docket类型的bean对象实例化过程[^1]。该实例负责处理整个应用程序内的所有RESTful服务端点的信息收集工作，并最终形成结构化的JSON格式数据供前端页面解析展示之用。

当一切准备就绪后，启动应用服务器并通过浏览器访问地址 `http://localhost:8080/doc.html#/home` 即可查看由Knife4j渲染后的交互式API文档界面[^2]。