伙伴匹配系统:Spring Boot 整合 Knife4j 接口文档

首先,什么是接口文档?写接口信息的文档,每条接口包括:


  1. 请求参数
  2. 响应参数
  3. 错误码
  4. 接口地址
  5. 接口名称
  6. 请求类型
  7. 请求格式
  8. 备注


who 谁用?


一搬是后端或者负责人来提供,后端和前端都要使用


为什么需要接口文档?


  1. 有个书面内容(背书或者归档),便于大家参考和查阅,便于沉淀和维护,拒绝口口相传
  2. 接口文档便于前端和后端开发对接,前后端联调的介质。后端 => 接口文档 <= 前端
  3. 好的接口文档支持在线调试、在线测试,可以作为工具提高我们的开发测试效率


怎么做接口文档?


  1. 手写(比如腾讯文档、Markdown笔记)
  2. 自动化接口文档生成:自动根据项目代码生成完整的文档或在线调试的网页。Swagger,Postman(侧重接口管理)(国外); apifox、apipost、eolink(国产)


开始整合


1. 引用依赖 Knife4j官网,根据 Springboot 版本选择不同的引用方式


如果不知道自己的Springboot是什么版本的,可以打开项目中的pom.xml文件中看



我这里的版本是2.6以上,故使用以下的引用:



将依赖加到pom.xml


点击引用依赖



2. 配置yml属性(这里也是要根据自己的版本来选择对应的yml属性):


knife4j:
enable: true
openapi:
title: Knife4j官方文档
description: "`我是测试`,**你知道吗**
# aaa"
email: xiaoymin@foxmail.com
concat: 八一菜刀
url: https://docs.xiaominfo.com
version: v4.0
license: Apache 2.0
license-url: https://stackoverflow.com/
terms-of-service-url: https://stackoverflow.com/
group:
test1:
group-name: 分组名称
api-rule: package
api-rule-resources:
- com.knife4j.demo.new3


注意要修改 api-rule-resources


选择接口所在的包,右击复制路径:





3. 配置完后重启app。


4. 最后,访问Knife4j的文档地址:http://ip:port/doc.html即可查看文档




最后的最后还是得说一句,配置api主要根据官方文档的说明进行配置,毕竟技术会更新迭代,dddd~

0个评论
点击登录,快来和大家讨论吧~
表情
图片
暂无评论
作者分享
加班两个月,感觉跟世界脱节了。。。 从4月底开始,一直在加班,每天晚上都熬的很晚,周末也要加(虽然没有动力加hhh,经常都在玩手机,一直拖到周日晚上才开始做),连续两个月都是这样,现在手头上算是忙完了。 但是感觉两个月世界变了很多,codeX、claude code、OpenClaw,这些都很经常刷到,也点进去了,但是没有精力看下去,慢慢的感觉自己好菜啊哈哈哈,看着同时用ai用的飞起来,自己却好像似懂非懂的感觉,莫名有点焦虑。 xdm,现在要从哪里学起?有没有能够推荐的方向?
5
xdm,我最新发现我学习项目可能有点误区?我目前是跟着项目一步一步走的,但项目的学习建议是先看完视频、整理好笔记再开始动手开发的,大家是怎么做的呢?
3
兄弟们,现在有鱼皮项目的学习顺序是什么,目前急于找工作,不知道应该专攻Java(云图库),还是改向看AI(最新的两个项目)了,有没有什么建议?
2
我想离职! 各位兄弟能给点意见吗,本人现在的状态很迷,可能是在舒适区呆久了,一直不敢尝试,去年7月份之前我都很拼,平时上班完回来还会去卷项目(用户中心、伙伴匹配),学Java,每天一点多睡,第二天早上六点半左右爬起来继续卷。 但是接下来出现了一场变故,也不能说是变故,现在回想起来其实早就已经有趋势了,7月份,我失恋了,跟我女朋友分手了,我至今为止都不知道为什么,可能是因为钱(反正现在对于我来说就是钱,可能有点自我主义了),她说她不想拿她的未来跟我赌,至此,我一蹶不振,下班之后不是打游戏就是玩手机,一到假期我能睡一整天,甚至一天吃一顿。 后来,九月份之后,我被公司安排去大西北驻场了半年,尤其是到了十二月份之后,那边就只有我一个人,很无助,很孤单,当时自己一个人之后又反复内耗,天天玩手机玩到三四点才睡觉,然后白天按时上班,周末就补觉,整个人也浑浑噩噩的。 后来到了放假前,我回广东了,放假途中我想了很多,先说说我自己吧,其实我这个人很纯粹,我曾经都相信只要努力就能成功,我的人生目标也很简单,赚大钱,跟我女朋友(现在应该是前女友了)一起好好生活,努力挣钱过上比较充裕的生活,但是现在好像并不是这样,有句话说的好,有的人出生在罗马,有的人出生就是牛马,我现在越发觉得我就是后者,我在清远长大(广东的一个山区)那边很穷,教育水平也很一般。噢,对了,我是独生子女,但是是单亲,所以对我来说,我自己的路都得我自己一个人摸着石头过河,家里的长辈都是初中文凭,更不用说给什么建议了。 大学毕业之前,我对未来都抱有希望,但是现在是残酷的,我目前所在的公司是自研框架,很夸张的那种,他们的大部分Java代码全部都掌握在核心部和少数人手上,我们这些底层的码农,只能通过写sql语句,调用他们封装好的Java类以及html、css、js,在这个公司,我学到的东西其实很少很少,噢!可能我sql写的很好,但是Java的话,我基本没怎么碰过,我之前也只是靠着鱼皮的项目才一点一点想起来Java是怎么写的。 回到正题,过年的时候我就跟家里人抱怨过,我说工资很低,而且很累,我想裸辞,他们说要不就先干着吧,现在就业也不容易,我也发过帖子跟网友们问过,大家也都是说,边做边找,不好找。但是,这份工作真的好累啊,每天下班后就像个废物一样躺在玩手机,我还不停的内耗,还深深陷在之前的爱情之中,很烦。 就在今天,我听到了一个消息,我两个同事要离职了,裸辞,他们说他们顶不住了,我慌了,因为他们手上的业务跟我手上的业务及其相似,我很怕,怕公司安排他们要跟我交接,要我接手他们的项目,接手他们的项目就代表了需要增加了运维和客服的工作量(忘记说了,我现在的工作包含了:调研、架构设计、开发、测试、运维、客服),我已经慌了,我现在完全不知道怎么办,我又很怕很怕我辞职后找不到工作....
12
各位道友有没有什么邪修的法子,除了上班之外,还有精力去学习😈
4
下载 APP