SpringBoot---集成 Knife4j,替代swagger2

	/**小编在最近的项目开发里面,集成了 knife4j,替代了之前的swagger,
		比较方便,这里分享一下操作步骤
	*/
	
	//1, pom.xml 文件配置依赖
	<dependency>
	    <groupId>com.github.xiaoymin</groupId>
	    <artifactId>knife4j-spring-boot-starter</artifactId>
	    <version>2.0.2</version>
	</dependency>
	
	//2,新建项目文件夹config,添加配置文件 SwaggerConfiguration.java
	//完整内容如下:
	---------------------------------------------------------------------------------------
	/**
     * @author: 
     * @description:
     * @date: 2021/11/12
     **/
	@Configuration
    @EnableSwagger2
    @EnableKnife4j
    public class SwaggerConfiguration {
        public Docket restApi() {
            Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .description("描述")
                        .version("1.0")
                        .build())
                .groupName("1.0版本")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cmbchina.controller")) // 项目controller根目录路径
                .paths(PathSelectors.any())
                .build();
        	return docket;
        }
    }
    -----------------------------------------------------------------------------------------
    
    
    //3, controller类 添加 @Api注解,表明事swagger资源
 	//方法 添加 @ApiOperation 注解,对方法进行描述
 	-----------------------------------------------------------------------------------------
 	/**
     * @author: 
     * @description:
     * @date: 2021/11/1
     **/
    @Api(tags = "接口切换状态查询 API")
    @RestController
    @RequestMapping("/switch")
	public class SwitchStatusController {

        @PostMapping("/getSwitchStatus")
        @ApiOperation("接口切换状态查询")
        public String saveElectronicCase() {
            return null;
        }
	}
	----------------------------------------------------------------------------------------
	
	//4,效果展示
	启动项目,浏览器地址中输入:   http://localhost:8080/doc.html#/
	即可使用knife4j
	







评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

皮皮克克

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值