knife4j——接口测试工具

最新推荐文章于 2024-05-07 10:30:16 发布

Rainbow_1991

最新推荐文章于 2024-05-07 10:30:16 发布

阅读量307

点赞数

文章标签： knife4j

本文链接：https://blog.csdn.net/qq_57689612/article/details/132154103

版权

本文介绍了如何在SpringBoot项目中使用Knife4j创建API文档，包括导入依赖、配置类、自动配置和使用@Api注解。读者将学习如何自定义接口命名、分类和实体类字段描述，以及通过URL访问生成的文档进行测试。

摘要由CSDN通过智能技术生成

文章目录

knife4j的使用

knife4j的使用

导入依赖

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

添加配置类

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
pubilc class Swagger2Configuration {
	@Bean(value = "defaultApi")
	public Docket defaultApi() {
		Docket docket = new Docket(DocumentationType.SWAGGER_2)
			.apiInfo(apiInfo())
			//分组名称
			.groupName("1.0")
			.select()
			//指定Controller扫描包路径
			.apis(RequestHandlerSelectors.basePackage("com.example"))
			.paths(PathSelectors.any())
			.build();
		return docket;
	}
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
			.title("API文档")
			.description("这是一个API文档")
			.version("1.0")
			.build();
	}
}

配置spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration = com.example.Swagger2Configuration

当 Spring Boot 应用程序启动时，它会加载 spring.factories 文件，并根据其中的配置信息执行相应的初始化动作。
通过在 spring.factories 文件中指定自动配置类，Spring Boot 可以自动根据依赖、类路径等条件来装配相应的配置和组件。

使用@Api等相关注解
在Controller上添加@Api，参数可选value、tags等，为接口取名分类等
在方法上加@ApiOperation("name")为接口取名
也可在实体类上加@ApiModelProperty()设置实体类的属性，可以使用required = true，说明该属性在请求或响应中是必须提供或返回的
访问knife4j
通过http://localhost:Port/doc.html访问knife4j
可在其中完成文档的查看下载以及接口的测试