草庐IT

IDEA插件Apifox,一键自动生成接口文档!

雨点的名字 2023-03-28 原文

有关Apifox软件之前写过一篇文章: 接口测试神器Apifox,亲测好用!

如何一键自动生成数据库文档之前也写过一篇文章: 数据库界的Swagger:一键生成数据库文档!

一、Apifox插件的优势

作为一名后端开发在项目开发过程中,肯定需要提供接口文档。

一般我们有两种方案

  1. 项目结合Swagger,自动生成接口文档。
  2. 手动将接口复制到其它接口文档,比如postman、Apifox。

第一种方案缺陷在于

  • 为了生成完整接口文档,我们会代码入侵且增加开发工作量
  • 当我们只需提供几个接口给第三方,总不能直接提供Swagger所有接口文档吧

第二种方案缺陷在于

  • 需要一个一个将接口写在对应的接口文档上,耗费大量时间
  • 当接口发生变更了,还需要修改下接口文档,会经常出现只修改接口忘记去修改接口文档的情况。

这时候这款插件神器就来了,它不仅可以解决上面的缺陷,而且还有更强大的功能,它可以支持直接在IDEA上做接口联调测试!


二、Apifox插件简单介绍

该插件主要用于 IDEA 项目快速生成 API 文档,并同步到 Apifox,代码零入侵

  • 基于 javadoc(Java)、KDoc(Kotlin)、ScalaDoc(Scala) 解析API文档。
  • 支持 Swagger 注解
  • 注意:可以在保持代码零侵入的情况下得到相当完整的 API 文档,但是特殊的需求还是需要部分特殊的注释/注解配合

功能特性

  • 导出 API 文档到 Apifox
  • 导出 Markdown 格式 API 文档
  • 在 IDEA 中直接发起 API 请求

三、IDEA安装插件

1、支持以下IDEA

  • IntelliJ IDEA 193.+(2019.3+)
  • IntelliJ IDEA Community Edition 174+(2017.4+)

2、搜索安装

  • 打开IDEA > Preferences(Settings) > Plugins ,搜索 Apifox Helper

安装完成后,你就可以使用上面说的功能特性了。

如果是同步到 Apifox 项目,你还需要下载或注册 Apifox 软件,创建一个对应的项目(这个具体操作看上面那篇文章就可以了)


四、 将IDEA项目和Apifox的项目关联

1、基础配置

安装插件后,进入设置界面 Preferences(Settings) > ApifoxUploader

1、 Apifox 服务器地址: 填写 Apifox API 服务地址,SaaS 版默认为 https://api.apifox.cn

2、 Apifox 个人访问令牌:就是你既然要同步到你的Apifox客户端,肯定需要在客户端拿到一个令牌

3、模块项目 ID 配置: 就是你要让IDEA知道 你要同步到Apifox客户端下面的哪个具体项目

2、个人访问令牌获取

在 Apifox软件中 点击个人头像处的 账号设置 中选择 API 访问令牌,新建令牌后复制生成的 Token 就是令牌。

3、模块项目 ID 配置

在 Apifox 中对应项目的 项目设置 中选择 基本设置,复制项目ID,填写在以上的对应位置处。

到目前为止,所有的准备设置工作都已经做好了,可以实现文档的自动生成和更新同步了。


五、自动生成接口文档测试

1.打开需要上传的 Controller 文件,右键选择 Upload to Apifox

2.去 Apifox 项目内,就可以看到刚才自动同步过来的文档了(如果你已经在当前项目了需要点击一下刷新)。

3.当后续接口代码有变动或更新时,再次点击 Upload to Apifox就可以同步。


六、直接在 IDEA 里调试

Apifox插件还有一个非常牛逼的功能就是支持在 IDEA 中一键发起接口自测,不需要切换其他软件。

在 IDEA 中选中需要调试的 API 文件,右键选择 Call API 发起请求就可以。

之后就可以在IDEA直接调试接口了,是不是非常方便!

还有许多细节的功能可以看他们的帮助文档,写的也非常的详细!

Apifox官方使用文档: https://www.apifox.cn/help/



声明: 公众号如需转载该篇文章,发表文章的头部一定要 告知是转至公众号: 后端元宇宙。同时也可以问本人要markdown原稿和原图片。其它情况一律禁止转载!

有关IDEA插件Apifox,一键自动生成接口文档!的更多相关文章

  1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  2. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  3. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件? - 2

    在选择我想要运行操作的频率时,唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案,但您可以安排它每天运行,并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/8692687/

  4. ruby-on-rails - 无法使用 Rails 3.2 创建插件? - 2

    我对最新版本的Rails有疑问。我创建了一个新应用程序(railsnewMyProject),但我没有脚本/生成,只有脚本/rails,当我输入ruby./script/railsgeneratepluginmy_plugin"Couldnotfindgeneratorplugin.".你知道如何生成插件模板吗?没有这个命令可以创建插件吗?PS:我正在使用Rails3.2.1和ruby​​1.8.7[universal-darwin11.0] 最佳答案 随着Rails3.2.0的发布,插件生成器已经被移除。查看变更日志here.现在

  5. ruby - 在 jRuby 中使用 'fork' 生成进程的替代方案? - 2

    在MRIRuby中我可以这样做:deftransferinternal_server=self.init_serverpid=forkdointernal_server.runend#Maketheserverprocessrunindependently.Process.detach(pid)internal_client=self.init_client#Dootherstuffwithconnectingtointernal_server...internal_client.post('somedata')ensure#KillserverProcess.kill('KILL',

  6. ruby - 如何使用 Ruby aws/s3 Gem 生成安全 URL 以从 s3 下载文件 - 2

    我正在编写一个小脚本来定位aws存储桶中的特定文件,并创建一个临时验证的url以发送给同事。(理想情况下,这将创建类似于在控制台上右键单击存储桶中的文件并复制链接地址的结果)。我研究过回形针,它似乎不符合这个标准,但我可能只是不知道它的全部功能。我尝试了以下方法:defauthenticated_url(file_name,bucket)AWS::S3::S3Object.url_for(file_name,bucket,:secure=>true,:expires=>20*60)end产生这种类型的结果:...-1.amazonaws.com/file_path/file.zip.A

  7. ruby - RuntimeError(自动加载常量 Apps 多线程时检测到循环依赖 - 2

    我收到这个错误:RuntimeError(自动加载常量Apps时检测到循环依赖当我使用多线程时。下面是我的代码。为什么会这样?我尝试多线程的原因是因为我正在编写一个HTML抓取应用程序。对Nokogiri::HTML(open())的调用是一个同步阻塞调用,需要1秒才能返回,我有100,000多个页面要访问,所以我试图运行多个线程来解决这个问题。有更好的方法吗?classToolsController0)app.website=array.join(',')putsapp.websiteelseapp.website="NONE"endapp.saveapps=Apps.order("

  8. ruby-on-rails - Ruby on Rails - 为文本区域和图片生成列 - 2

    我是Rails的新手,所以请原谅简单的问题。我正在为一家公司创建一个网站。那家公司想在网站上展示它的客户。我想让客户自己管理这个。我正在为“客户”生成一个表格,我想要的三列是:公司名称、公司描述和Logo。对于名称,我使用的是name:string但不确定如何在脚本/生成脚手架终端命令中最好地创建描述列(因为我打算将其设置为文本区域)和图片。我怀疑描述(我想成为一个文本区域)应该仍然是描述:字符串,然后以实际形式进行调整。不确定如何处理图片字段。那么……说来话长:我在脚手架命令中输入什么来生成描述和图片列? 最佳答案 对于“文本”数

  9. ruby-on-rails - 如何生成传递一些自定义参数的 `link_to` URL? - 2

    我正在使用RubyonRails3.0.9,我想生成一个传递一些自定义参数的link_toURL。也就是说,有一个articles_path(www.my_web_site_name.com/articles)我想生成如下内容:link_to'Samplelinktitle',...#HereIshouldimplementthecode#=>'http://www.my_web_site_name.com/articles?param1=value1¶m2=value2&...我如何编写link_to语句“alàRubyonRailsWay”以实现该目的?如果我想通过传递一些

  10. ruby-on-rails - 如何在 Rails 3 中创建自定义脚手架生成器? - 2

    有这些railscast。http://railscasts.com/episodes/218-making-generators-in-rails-3有了这个,你就会知道如何创建样式表和脚手架生成器。http://railscasts.com/episodes/216-generators-in-rails-3通过这个,您可以了解如何添加一些文件来修改脚手架View。我想把两者结合起来。我想创建一个生成器,它也可以创建脚手架View。有点像RyanBates漂亮的生成器或web_app_themegem(https://github.com/pilu/web-app-theme)。我

随机推荐