集成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信息

● 可以下载离线文档

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

相关文章
|
前端开发 数据安全/隐私保护
若依框架---权限控制角色设计
若依框架---权限控制角色设计
4320 0
|
数据可视化 前端开发 Java
简单使用Swagger
Swagger是一个用于生成、描述和可视化RESTful服务的框架,简化前后端分离开发,自动化接口文档生成,支持功能测试。Springfox是Spring中的Swagger实现。Knife4j是Java MVC的Swagger增强工具,提供更便捷的Api文档生成。使用步骤包括添加依赖、配置Docket、设置静态资源映射。常用注解如`@Api`, `@ApiOperation`, `@ApiModel`, `@ApiModelProperty`用于美化接口文档。虽然Swagger可生成接口文档,但它与设计阶段工具如Yapi互补,分别适用于开发和设计阶段。
449 3
简单使用Swagger
|
Java 数据安全/隐私保护 数据格式
Spring Cloud Gateway 网关整合 Knife4j 4.3 实现微服务接口文档聚合
Spring Cloud Gateway 网关整合 Knife4j 4.3 实现微服务接口文档聚合
|
小程序 Java Maven
小程序订阅消息推送工具类
小程序订阅消息推送工具类
351 0
|
人工智能 Java Serverless
【MCP教程系列】搭建基于 Spring AI 的 SSE 模式 MCP 服务并自定义部署至阿里云百炼
本文详细介绍了如何基于Spring AI搭建支持SSE模式的MCP服务,并成功集成至阿里云百炼大模型平台。通过四个步骤实现从零到Agent的构建,包括项目创建、工具开发、服务测试与部署。文章还提供了具体代码示例和操作截图,帮助读者快速上手。最终,将自定义SSE MCP服务集成到百炼平台,完成智能体应用的创建与测试。适合希望了解SSE实时交互及大模型集成的开发者参考。
14462 60
|
安全 Java 开发者
Java 21 新特性详解(Record、Pattern Matching、Switch 改进)
Java 21发布,作为LTS版本带来Record模式匹配、Switch表达式增强等重要特性,提升代码简洁性与可读性。支持嵌套匹配、类型检查与条件判断,结合密封类实现安全多态,优化性能并减少冗余代码,助力开发者构建更高效、清晰的现代Java应用。
928 2
|
4月前
|
机器学习/深度学习 人工智能 前端开发
终端里的 AI 编程助手:OpenCode 使用指南
OpenCode 是开源的终端 AI 编码助手,支持 Claude、GPT-4 等模型,可在命令行完成代码编写、Bug 修复、项目重构。提供原生终端界面和上下文感知能力,适合全栈开发者和终端用户使用。
42301 11
|
API Java 监控
SpringBoot基于OpenAPI3的接口文档管理快速集成和使用
本文主要简单介绍SpringCloud2023中进行接口文档管理,方便前后端开发和文档维护。文档管理工具基于开源的knife4j封装的openapi3。
1882 3
|
网络协议 开发工具 git
hexo github部署,通过域名访问你的博客
本文介绍了如何使用Hexo命令部署博客到GitHub,并详细说明了如何通过自定义域名访问GitHub上部署的博客。
hexo github部署,通过域名访问你的博客