/**小编在最近的项目开发里面,集成了 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
SpringBoot---集成 Knife4j,替代swagger2
最新推荐文章于 2024-08-18 06:15:00 发布