本篇文章具体教你怎么运用 Apifox 的 IDEA 插件完成主动生成接口代码。好处简单总结有以下几点:

  1. 主动生成接口文档: 不必手写,一键点击就能够主动生成文档,当有更新时,点击一下就能够主动同步接口文档;
  2. 代码零侵略: 完美处理了运用 Swagger 在我们的代码中额定增加各种注解,导致代码可读性极差、侵略了逻辑代码的问题;
  3. 团队协作更便利: 不需要导出文件,云端办理,直接共享链接给团队即可;
  4. 生成的文档好看! (如下图)

如何自动生成 API 接口文档 - 一份详细指南

第一步:装置 Apifox IDEA 插件(Apifox Helper)

翻开你的 IDEA,点击 File –>Settings –> Plugins,搜索 Apifox Helper。 点击装置。

如何自动生成 API 接口文档 - 一份详细指南

第二步:装备 Apifox 拜访令牌 和项目 ID

(这一步假设你现已注册过 Apifox,且现已创立了项目。如果没有,请去注册 并且创立一个项目用来同步你的接口文档。)

接下来,你需要将 Apifox Helper 和 Apifox 的项目进行相关,也便是经过拜访令牌绑定。

1、翻开 Apifox, 点击左侧【头像】–>【账号设置】–>【API 拜访令牌】–>【新建令牌】,填写令牌称号,点击【保存并生成令牌]】,仿制令牌;

如何自动生成 API 接口文档 - 一份详细指南

2、在 Apifox 中进入项目,【项目设置 –> 根本设置】,仿制项目 ID 。

如何自动生成 API 接口文档 - 一份详细指南

在 IDEA 中,点击 File–>Settings –>Other Settings,找到 Apifox Helper。 将刚才仿制的拜访令牌和项目 ID 粘贴到这儿:

3、(服务器地址就用默许的,能够不必管。)

如何自动生成 API 接口文档 - 一份详细指南

到这儿,你就搞定了装备部分,下面便是主动生成文档了!

第三步:主动生成文档!

在 IDEA 中右键点击「 Upload to Apifox」,就能够生成 API 接口文档了!Upload to Apifox 能够生成单个接口,也能一键把 Controller 里面的所有接口悉数生成!乃至把整个项目上右键一起生成接口文档。

如何自动生成 API 接口文档 - 一份详细指南

第四步:去 Apifox 项目中查看主动生成的文档

点击 Apifox 右上角的刷新图标。刚才在 IDEA 项目中的接口文档就现已在这儿了。

如何自动生成 API 接口文档 - 一份详细指南

这样,你就功德圆满了!祝贺你现已具有了一份美观整齐的接口文档。这个项目一旦有更新,你只需要右键点击「 Upload to Apifox」 就能够。别的还能够经过阅览 Apifox 插件官方协助文档 ,协助你处理更多特定业务情形的插件运用问题。

Apifox 更多好用的功用

在线共享接口文档

当你的文档同步到项目中,那么你就能够直接在 Apifox 中直接生成一个共享链接给他人,那么他看到的文档就都是最新的,不需要再管你索要接口文档文件。

如何自动生成 API 接口文档 - 一份详细指南

调试便利

当你经过插件同步了文档到 Apifox 项目里后,前端同学直接在文档内就能够一键点击「运转」调试,不需要再仿制粘贴、也不需要和后端开发重复核对参数等信息。

如何自动生成 API 接口文档 - 一份详细指南

云端 Mock

Apifox 内置强大的 Mock 才能,能够直接生成非常智能、人性化的 Mock 数据。把接口文档中的 Mock 功用翻开,仿制链接到浏览器中回车一下,就能得到 Mock 数据。前端在后端的接口出来之前就能够经过 Mock 功用来制造假数据接口来进行开发和调试。

如何自动生成 API 接口文档 - 一份详细指南
如何自动生成 API 接口文档 - 一份详细指南

接口主动化测验才能

测验同学也能够在 Apifox 对接口进行测验。每个接口文档能够快速生成多个不同状态(成功、失利)的测验用例。

如何自动生成 API 接口文档 - 一份详细指南

对测验步骤进行编排,模拟业务情形设置测验流程操控条件(循环、判断、等待):

如何自动生成 API 接口文档 - 一份详细指南

了解更多主动生成文档的方法。

  • 主动生成 API 文档 – Flask 项目完成
  • 怎么运用 Swagger 主动生成 API 文档