AI超级智能体项目教程(二)---后端项目初始化(设计knif4j接口文档的使用)
文章目录
- 1.选择JDK的版本和相关配置
- 2.添加依赖信息
- 2.1指定lombok版本信息
- 2.2引入hutool工具类
- 2.3了解knif4j依赖
- 2.4引入knif4j依赖
- 3.contrller测试
- 3.1完成yml文件配置
- 3.2修改默认扫描路径
- 3.3controller具体的内容
- 3.4配置接口和访问路径
- 3.5如何访问
- 3.6调试接口
- 3.6调试接口
1.选择JDK的版本和相关配置
首先我们还是去初始化这个项目,我们创建的还是这个spring-boot项目,但是和我们的日常学习不一样的是,我们的这个JDK选择的就是java21版本;
具体的这个配置的情况如下图所示:
下面的这个spring的版本和我们的相关的依赖,这个依赖装一下这个lombok和这个spring web就可以了,其他的都是我们的这个项目创建之后手动指定的;
2.添加依赖信息
2.1指定lombok版本信息
2.2引入hutool工具类
下面的这个就是这个工具类对应的这个官方的文档,我们是可以直接搜索得到这个对应的xml引入的这个对应的代码的;
下面的这个就是引入到我们的这个项目的pom.xml文件里面去:
2.3了解knif4j依赖
这个实际上就是接口文档,类似于我们之前了解过的这个swagger,两个的这个作用就是类似的,大家可以这样去进行理解,因此这个knif4j也是这个类似的作用,因为我们的这个项目里面涉及到了很多的这个接口,我们使用这个knif4j方便对于我们的这个项目里面的所有的接口进行管理;
2.4引入knif4j依赖
这个也是可以在我们的官方文档里面找到的:
这个就是在我们的项目里面引入了这个对应的相关依赖的一个情况吧:
3.contrller测试
3.1完成yml文件配置
下面的这个就是我们的yml格式的这个配置,我们去放到我们自己的这个项目工程里面就好了;
3.2修改默认扫描路径
下面的这个就是我们修改默认扫描路径,也就是我们新建的这个controller对应的这个路径的情况吧;
3.3controller具体的内容
其实这个就是用来测试的,我们看看这个可不可行,所以随便在这个里面写点东西就可以了;
3.4配置接口和访问路径
下面的这个就是我们的配置接口和这个路径访问的指定路径方式
3.5如何访问
这个就是我们访问的url,这个里面的api就是我们的项目里面的这个context-path这个路径里面进行指定的内容;
3.6调试接口
找到这个里面的接口,选择调试,这个时候发送之后就是可以看到正确的返回值:
ftvlR-1745581138331)]
3.6调试接口
找到这个里面的接口,选择调试,这个时候发送之后就是可以看到正确的返回值: