ps做淘宝网站导航栏,重庆网网站建设公司,muiteer主题 wordpress,大连网站建设方案咨询Knife4j使用 文章目录 Knife4j使用1、Knife4j介绍2、SpringBoot集成Knife4j3、基本使用 1、Knife4j介绍
Knife4j是一个用于生成和展示API文档的工具#xff0c;同时它还提供了在线调试的功能#xff0c;可以看作是Swagger的升级版#xff0c;界面也比Swagger更好看#xf…Knife4j使用 文章目录 Knife4j使用1、Knife4j介绍2、SpringBoot集成Knife4j3、基本使用 1、Knife4j介绍
Knife4j是一个用于生成和展示API文档的工具同时它还提供了在线调试的功能可以看作是Swagger的升级版界面也比Swagger更好看下图是其工作界面。 了解
Knife4j有多个版本最新版的Knife4j基于开源项目springdoc-openapi这个开源项目的核心功能就是根据SpringBoot项目中的代码自动生成符合OpenAPI规范的接口信息。OpenAPI规范定义接口文档的内容和格式其前身是Swagger规范。
2、SpringBoot集成Knife4j 在SpringBoot项目使用需要先导入依赖 dependencygroupIdcom.github.xiaoymin/groupIdartifactIdknife4j-openapi3-jakarta-spring-boot-starter/artifactIdversion4.3.0/version
/dependency之后再创建对应的配置类 Configuration
public class Knife4jConfiguration {Beanpublic OpenAPI openAPI() {return new OpenAPI().info(new Info().title(hello-knife4j项目API).version(1.0).description(hello-knife4j项目的接口文档));}Beanpublic GroupedOpenApi userAPI() {return GroupedOpenApi.builder().group(用户信息管理).pathsToMatch(/user/**).build();}Beanpublic GroupedOpenApi systemAPI() {return GroupedOpenApi.builder().group(产品信息管理).pathsToMatch(/product/**).build();}
}启动项目 3、基本使用 创建实体类进行测试 Schema注解用于描述作为接口参数或者返回值的实体类的数据结构 Data
Schema(description 用户信息实体)
public class User {Schema(description 编号)private Long id;Schema(description 用户姓名)private String name;Schema(description 用户年龄)private Integer age;Schema(description 用户邮箱)private String email;
}创建Controller接口 Tag注解用于对接口进行分类相同Tag的接口会放在同一个菜单。 Operation用于对接口进行描述。 Parameter用于对HTTP请求参数进行描述 RestController
RequestMapping(/user)
Tag(name 用户信息管理)
public class HelloController {Operation(summary 根据id获取用户信息)GetMapping(getById)public User getUserById(Parameter(description 用户id) RequestParam Long id) {User user new User();user.setId(id);user.setName(zhangsan);user.setAge(11);user.setEmail(zhangsanemail.com);return user;}
}查看Knife4j界面
