SpringBoot整合篇—knife4

一:引入maven依赖

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

第二步编写Config


package com.rj9.config;

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;

/**
 * Swagger的配置类
 */
@Configuration
@EnableSwagger2
public class MyKnife4jConfiguration {
   
    @Bean
    public Docket createRestApi() {
   
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径,控制器类包
                .apis(RequestHandlerSelectors.basePackage("com.rj9.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
   
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot 集成 knife4 测试接口文档")
                //创建人
                .contact(new Contact("嗨嗨嗨!", "http://www.baidu.com", "@qq.com"))
                //版本号
                .version("1.0")
                //描述
                
### 整合 Knife4j 到 Spring Boot 2 项目 为了在Spring Boot 2项目中集成Knife4j并实现API文档的自动生成,需按照如下说明操作。 #### 添加依赖项 确保已拥有一个Spring Boot 2项目。如果尚未创建,则可通过Spring Initializr快速构建一个新的项目[^2]。接着,在项目的`pom.xml`文件内加入Knife4j的相关Maven依赖: ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.9</version> </dependency> ``` 此步骤引入了必要的库来支持Knife4j的功能,包括但不限于美化后的Swagger UI界面以及增强型的API描述能力。 #### 启用 Swagger 和 Knife4j 支持 为了让应用程序能够识别这些新添加的支持特性,还需激活相应的自动配置类。这通常意味着要在主程序入口处或是任意@Configuration标注过的Java配置类里声明@EnableSwagger2Doc注解: ```java import com.github.xiaoymin.knife4j.spring.boot.annotation.EnableSwagger2Doc; import org.springframework.context.annotation.Configuration; @Configuration @EnableSwagger2Doc public class SwaggerConfig { } ``` 上述代码片段启用了对Swagger 2规范的支持,并进一步集成了由Knife4j所提供的额外特性和改进措施[^3]。 #### 访问生成的 API 文档 完成以上设置之后,只需正常启动Spring Boot应用即可。一旦服务运行起来,便能通过浏览器访问默认路径`http://localhost:8080/doc.html`来浏览由Knife4j渲染出来的交互式API文档页面[^5]。 此外,值得注意的是,在实际部署至生产环境前应当仔细审查安全策略,防止不必要的信息暴露给外部用户;同时也建议定期检查所使用的各组件间是否存在版本兼容性问题。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值