集成Knife4j

简介: knife4j是Java MVC框架集成Swagger的增强工具,前身swagger-bootstrap-ui,旨在提供更美观、易用的API文档界面。轻量如匕首,功能强大,支持全局参数设置、离线文档下载、友好测试界面。集成简便,通过引入starter依赖并访问/doc.html即可使用,助力前后端高效协作,提升接口调试与维护体验。

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名knife4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!
目前,一般都使用knife4j框架,集成方式参考链接:链接
父工程zzyl/pom.xml

3.0.3
版本锁定依赖,在父工程添加


com.github.xiaoymin
knife4j-spring-boot-starter
${knife4j.version}

zzyl-common/pom.xml


com.github.xiaoymin
knife4j-spring-boot-starter

前端修改: 将路径修改为doc.html

重启前后端工程,实现后的效果(内部使用)

外部使用:http://localhost:8080/doc.html#/home
● 可以设置全局参数
由于若依中的所有接口都已经做了安全校验,在访问之前,我们必须设置一个全局参数来获取到登录之后的token才可以正常访问,不然会报一个401错误

解决:
当我们正常登录系统之后,就可以在后端获取一个jwt生成的token,这个token是登录成功的标识,后期其他请求都需要携带这个token才能正常访问
我们可以在浏览器中打开F12,查看网络,当登录成功后可以查看返回的token

有了token以后,就可以把这个token设置到全局参数中
● key=Authorization
● value=请求头token信息

● 可以下载离线文档

● 提供了更好的接口文档阅读界面
● 提供了更方便的接口测试

相关文章
|
18小时前
操作日志-处理流程
`@Log` 是一个自定义操作日志注解,用于记录系统操作信息。可指定模块标题、业务类型、操作人类型,并支持是否保存请求/响应参数及排除敏感字段,适用于管理类操作的日志追踪。
|
18小时前
4 多对多
通过引入第三方类UserForDept关联用户与部门,实现多对多映射。在User和Dept类中分别添加对方集合,并在mapper.xml中配置collection关联UsersForDept,便于灵活管理多部门与多用户间的关系,适用于复杂权限场景。(236字)
|
18小时前
|
存储 NoSQL MongoDB
4.2.3 其他索引
MongoDB提供地理空间索引支持平面与球面查询,文本索引实现高效字符串搜索并提取词干,哈希索引则用于散列分片,仅支持等值匹配,提升数据分布随机性。
|
18小时前
2.映射关系(1-1 1-n n-n)
一对一通过ResultMap实现属性与字段映射,解决命名不一致问题;一对多需在“一”方添加集合属性,并在resultMap中使用<collection>标签映射关联对象,如用户与角色关系。
|
18小时前
3.5 文档的分页查询
统计查询使用count()方法,可统计集合中符合条件的记录数量。语法为db.collection.count(query, options)。如统计comment集合全部记录:db.comment.count();按条件统计userid为1003的记录数:db.comment.count({userid:"1003"})。默认返回所有匹配文档的数量。
|
18小时前
|
存储 NoSQL 关系型数据库
4-MongoDB索引知识
MongoDB索引通过B树结构提升查询效率,避免全表扫描。支持单字段和复合索引,前者适用于单一字段排序与查询,后者按字段顺序构建,优化多条件查询与排序操作,显著提升大数据量下的查询性能。
|
18小时前
3.5.3 排序查询
sort()方法用于对查询结果排序,1为升序,-1为降序,可按多字段排序。语法:db.集合名.find().sort({字段:1/-1})。与skip()、limit()联用时,执行顺序为先排序,再跳过,最后限制显示。
|
1天前
|
安全 Java 大数据
ArrayList扩容机制
初始化Map应避免容量设置不当,推荐使用Guava的`newHashMapWithExpectedSize`或手动计算初始容量。禁止使用`Executors`创建线程池,易因无界队列或过多线程引发OOM,应显式通过`ThreadPoolExecutor`构建,推荐结合Guava设置命名线程工厂。`Arrays.asList`返回不可变列表,禁止修改操作;遍历Map时优先使用`entrySet`提升性能;`SimpleDateFormat`非线程安全,建议用`ThreadLocal`隔离或JDK8新时间API;并发更新记录需加锁,推荐乐观锁(version控制),冲突率低时重试不少于3次。
|
18小时前
|
存储 NoSQL Linux
2.4 Linux系统中的安装启动和连接
本文介绍在Linux系统部署单机MongoDB用于生产环境的完整步骤,包括下载、解压、目录配置、日志与数据路径设置、配置文件编写及服务启停方法。操作类似Windows,通过配置`mongod.conf`实现后台运行,支持命令行与图形工具连接,并提供防火墙处理与安全关闭服务方案,确保稳定运行。
|
18小时前
|
NoSQL MongoDB
3.4.4 删除文档
MongoDB中删除文档使用`db.集合名称.remove(条件)`语法。如`db.comment.remove({})`将清空集合,慎用;删除指定_id的记录如`db.comment.remove({_id:"1"})`,按条件精准删除数据。