Knife4j生成和展示API文档工具

Knife4j用户生成后端项目的Controller接口文档

①、依赖

knife4j-openapi3-jakarta-spring-boot-starter

②、创建配置类

@Configuration
public class Knife4jConfiguration{
	
	@Bean
	public OpenAPI openAPI(){
		return new OpenAPI()
			.info(new Info()
					.title("hello-knife4j项目API")
					.version("1.0")
					.description("hello-knife4j项目的接口文档"));
	}

	@Bean
	public GroupedOpenApi userAPI(){
		return GroupedOpenApi.builder().group("用户信息管理")
			.pathsToMatch("/user/**")
			.build();
	}

	@Bean
	public GroupedOpenApi systemAPI(){
		return GroupedOpenApi.builder().group("产品信息管理")
			.pathsToMatch("/product/**")
			.build();
	}
}

③、启动SpringBoot项目

http://localhost:8080/doc.html

Controller接口中常用的注解

• @Tag 组标签
• @Oprration 左侧栏的标签说明
• @Parameter 请求参数
• @Schema 响应参数

@RestController
@RequestMapping("/user")
@Tag(name="用户信息管理")
public class UserController{
	
	@GetMapping("getById")
	@Oprration(name="根据ID查询用户信息")
	public User getById(@Parameter(description = "用户ID") @ReqeustParam("id") Integer id){
		User user = new User();
		user.setId(id);
		user.setName("zhangsan");
		user.setAge(10);
		return user;
	}
}

@Data
@Schema(description = "用户信息实体")
public class User{
	
	@Schema(description = "用户ID")
	private Integer id;
	
	@Schema(description = "用户姓名")
	private String name;
	
	@Schema(description = "用户年龄")
	private Integer age;
}