idea+ApifoxUploader+Apifox真是内外双修,香
创始人
2024-05-20 00:19:45
0

前言

        最近部门为整合后端组、前端组、测试组、需求组、产品组等组之间的工作流程,旨在提高协调与高效,其中之一就是希望开发组(后端、前端)开发的接口能及时更新,测试组能做接口测试,后期方便出文档,所以建议全员开始用Apifox,组员分享使用,确实不错,我这里就补充下idea插件Apifox uploader的结合使用,也正因为有这个插件,可以解放后端的工作方式,依然可以先先代码,后补文档。当然谁都知道先写文档,再写代码会更严谨,但是就我们公司这个规模,这种敏捷开发模式下,有点不现实。好,废话不多说,上重点。


一、Apifox uploader插件安装

这个直接在idea的插件库搜索api就可以看到了,例如:
在这里插入图片描述
        安装细节就不多说了,自己折腾吧,apifox官网也有介绍。

二、使用步骤

1.插件设置

首先看下界面:
在这里插入图片描述
主要是这个访问令牌要先在apifox获取到,具体看官网的帮助文档,或者在这里点击“了解更多”
https://www.apifox.cn/help/ide-plugin/idea-plugin/quickstart/get-access-token/

2.模块项目ID配置

插件在这里给了配置示例,这里我解释下:
格式是:modleName:ProjectID
        modleName实际就是项目的名称,如果是微服务或父子服务,modleName是各个模块的名称(目录名称)
        ProjectID来源Apifox建的项目,在项目的基础设置里可以看到:
在这里插入图片描述

3.插件使用

        光标放在modle上,点右键,弹出的菜单找到“uploade to apifox”,点击它,就ok了。
在这里插入图片描述
        然后再apifox客户端软件上刷新下,就可以看到接口信息、数据模型了,如下:
在这里插入图片描述
        更加具体的使用,可以取官网查看。这里要说下的是一定要写javadoc注释,这些、目录名称、接口名称均是来源于此。当然也可以设置插件使用其他有代码侵入的注解的注释,apifox也是支持的。先看看我这里的Controller的注释:
在这里插入图片描述


总结

  • Apifox出文档真香,格式比一般的都好看一点
  • Apifox uploader插件加持,更是如虎添翼,敏捷开发模式的福音
  • 后期测试、压测、mock等等确实方便不少,只要有注释,前端小姐姐再也不用追着你问对应字段了
  • 当然确定也是有的,比如生成的接口url,如果有在路径上获取的参数,文档与springBoot没有做到一致,springBoot上是{},但是接口上如果想把这个参数拿出来在外面设置全局参数等等方式,url上是缺少{}的,这一点自己去体会,当然,可以要求规范不允许使用路径传参
  • 目前还不收费,后期可就难说
  • 有一定风险,因为接口信息是放在apifox的https://api.apifox.cn服务器上的
    好了,就到这里,希望能帮到大家,uping!!!

相关内容

热门资讯

常用商务英语口语   商务英语是以适应职场生活的语言要求为目的,内容涉及到商务活动的方方面面。下面是小编收集的常用商务...
六年级上册英语第一单元练习题   一、根据要求写单词。  1.dry(反义词)__________________  2.writ...
复活节英文怎么说 复活节英文怎么说?复活节的英语翻译是什么?复活节:Easter;"Easter,anniversar...
2008年北京奥运会主题曲 2008年北京奥运会(第29届夏季奥林匹克运动会),2008年8月8日到2008年8月24日在中华人...
英语道歉信 英语道歉信15篇  在日常生活中,道歉信的使用频率越来越高,通过道歉信,我们可以更好地解释事情发生的...
六年级英语专题训练(连词成句... 六年级英语专题训练(连词成句30题)  1. have,playhouse,many,I,toy,i...
上班迟到情况说明英语   每个人都或多或少的迟到过那么几次,因为各种原因,可能生病,可能因为交通堵车,可能是因为天气冷,有...
小学英语教学论文 小学英语教学论文范文  引导语:英语教育一直都是每个家长所器重的,那么有关小学英语教学论文要怎么写呢...
英语口语学习必看的方法技巧 英语口语学习必看的方法技巧如何才能说流利的英语? 说外语时,我们主要应做到四件事:理解、回答、提问、...
四级英语作文选:Birth ... 四级英语作文范文选:Birth controlSince the Chinese Governmen...
金融专业英语面试自我介绍 金融专业英语面试自我介绍3篇  金融专业的学生面试时,面试官要求用英语做自我介绍该怎么说。下面是小编...
我的李老师走了四年级英语日记... 我的李老师走了四年级英语日记带翻译  我上了五个学期的小学却换了六任老师,李老师是带我们班最长的语文...
小学三年级英语日记带翻译捡玉... 小学三年级英语日记带翻译捡玉米  今天,我和妈妈去外婆家,外婆家有刚剥的`玉米棒上带有玉米籽,好大的...
七年级英语优秀教学设计 七年级英语优秀教学设计  作为一位兢兢业业的人民教师,常常要写一份优秀的教学设计,教学设计是把教学原...
我的英语老师作文 我的英语老师作文(通用21篇)  在日常生活或是工作学习中,大家都有写作文的经历,对作文很是熟悉吧,...
英语老师教学经验总结 英语老师教学经验总结(通用19篇)  总结是指社会团体、企业单位和个人对某一阶段的学习、工作或其完成...
初一英语暑假作业答案 初一英语暑假作业答案  英语练习一(基础训练)第一题1.D2.H3.E4.F5.I6.A7.J8.C...
大学生的英语演讲稿 大学生的英语演讲稿范文(精选10篇)  使用正确的写作思路书写演讲稿会更加事半功倍。在现实社会中,越...
VOA美国之音英语学习网址 VOA美国之音英语学习推荐网址 美国之音网站已经成为语言学习最重要的资源站点,在互联网上还有若干网站...
商务英语期末试卷 Part I Term Translation (20%)Section A: Translate ...