乐趣区

关于后端:如何自动生成-API-接口文档-一份详细指南

本篇文章具体教你如何应用 Apifox 的 IDEA 插件实现主动生成接口代码。益处简略总结有以下几点:

  1. 主动生成接口文档: 不必手写,一键点击就能够主动生成文档,当有更新时,点击一下就能够主动同步接口文档;
  2. 代码零入侵: 完满解决了应用 Swagger 在咱们的代码中额定减少各种注解,导致代码可读性极差、入侵了逻辑代码的问题;
  3. 团队单干更不便: 不须要导出文件,云端治理,间接分享链接给团队即可;
  4. 生成的文档难看!(如下图)

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

关上你的 IDEA,点击 File –>Settings –> Plugins, 搜寻 Apifox Helper。 点击装置。

第二步:配置 Apifox 拜访令牌 和我的项目 ID

(这一步假如你曾经注册过 Apifox,且曾经创立了我的项目。如果没有,请 [](https://www.apifox.com/) 去注册 并且创立一个我的项目用来同步你的接口文档。)

接下来,你须要将 Apifox Helper 和 Apifox 的我的项目进行关联,也就是通过拜访令牌绑定。

1、关上 Apifox,点击左侧【头像】–>【账号设置】–>【API 拜访令牌】–>【新建令牌】, 填写令牌名称,点击【保留并生成令牌]】,复制令牌;

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

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

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

到这里,你就搞定了配置局部,上面就是主动生成文档了!

第三步:主动生成文档!

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

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

点击 Apifox 右上角的刷新图标。方才在 IDEA 我的项目中的接口文档就曾经在这里了。

这样,你就功败垂成了!祝贺你曾经领有了一份好看整洁的接口文档。这个我的项目一旦有更新,你只须要右键点击「Upload to Apifox」就能够。另外还能够通过浏览 Apifox 插件官网帮忙文档,帮忙你解决更多特定业务情景的插件应用问题。

Apifox 更多好用的性能

在线分享接口文档

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

调试不便

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

云端 Mock

Apifox 内置弱小的 Mock 能力,能够间接生成十分智能、人性化的 Mock 数据。把接口文档中的 Mock 性能关上,复制链接到浏览器中回车一下,就能失去 Mock 数据。前端在后端的接口进去之前就能够通过 Mock 性能来制作假数据接口来进行开发和调试。

接口自动化测试能力

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

对测试步骤进行编排,模仿业务情景设置测试流程管制条件(循环、判断、期待):

理解更多主动生成文档的办法。

  • 主动生成 API 文档 – Flask 我的项目实现
  • 如何应用 Swagger 主动生成 API 文档
退出移动版