如何自动生成 API 接口文档 - 一份详细指南
本篇文章详细教你如何使用 Apifox 的 IDEA 插件实现自动生成接口代码。好处简单总结有以下几点:
- 自动生成接口文档: 不用手写,一键点击就可以自动生成文档,当有更新时,点击一下就可以自动同步接口文档;
- 代码零入侵: 完美解决了使用 Swagger 在我们的代码中额外增加各种注解,导致代码可读性极差、入侵了逻辑代码的问题;
- 团队合作更方便: 不需要导出文件,云端管理,直接分享链接给团队即可;
- 生成的文档好看! (如下图)
![](/assets/blank.gif)
第一步:安装 Apifox IDEA 插件(Apifox Helper)
打开你的 IDEA,点击 File -->Settings --> Plugins,搜索 Apifox Helper。 点击安装。
![](/assets/blank.gif)
第二步:配置 Apifox 访问令牌 和项目 ID
(这一步假设你已经注册过 Apifox,且已经创建了项目。如果没有,请去注册 并且创建一个项目用来同步你的接口文档。)
接下来,你需要将 Apifox Helper 和 Apifox 的项目进行关联,也就是通过访问令牌绑定。
1、打开 Apifox, 点击左侧【头像】-->【账号设置】-->【API 访问令牌】-->【新建令牌】,填写令牌名称,点击【保存并生成令牌]】,复制令牌;
![](/assets/blank.gif)
2、在 Apifox 中进入项目,【项目设置 --> 基本设置】,复制项目 ID 。
![](/assets/blank.gif)
在 IDEA 中,点击 File-->Settings -->Other Settings,找到 Apifox Helper。 将刚才复制的访问令牌和项目 ID 粘贴到这里:
3、(服务器地址就用默认的,可以不用管。)
![](/assets/blank.gif)
到这里,你就搞定了配置部分,下面就是自动生成文档了!
第三步:自动生成文档!
在 IDEA 中右键点击「 Upload to Apifox」,就可以生成 API 接口文档了!Upload to Apifox 可以生成单个接口,也能一键把 Controller 里面的所有接口全部生成!甚至把整个项目上右键一起生成接口文档。
![](/assets/blank.gif)
第四步:去 Apifox 项目中查看自动生成的文档
点击 Apifox 右上角的刷新图标。刚才在 IDEA 项目中的接口文档就已经在这里了。
![](/assets/blank.gif)
这样,你就大功告成了!恭喜你已经拥有了一份美观整洁的接口文档。这个项目一旦有更新,你只需要右键点击「 Upload to Apifox」 就可以。另外还可以通过阅读 Apifox 插件官方帮助文档 ,帮助你解决更多特定业务情景的插件使用问题。
Apifox 更多好用的功能
在线分享接口文档
当你的文档同步到项目中,那么你就可以直接在 Apifox 中直接生成一个分享链接给别人,那么他看到的文档就都是最新的,不需要再管你索要接口文档文件。
![](/assets/blank.gif)
调试方便
当你通过插件同步了文档到 Apifox 项目里后,前端同学直接在文档内就可以一键点击「运行」调试,不需要再复制粘贴、也不需要和后端开发反复核对参数等信息。
![](/assets/blank.gif)
云端 Mock
Apifox 内置强大的 Mock 能力,可以直接生成非常智能、人性化的 Mock 数据。把接口文档中的 Mock 功能打开,复制链接到浏览器中回车一下,就能得到 Mock 数据。前端在后端的接口出来之前就可以通过 Mock 功能来制造假数据接口来进行开发和调试。
![](/assets/blank.gif)
接口自动化测试能力
测试同学也可以在 Apifox 对接口进行测试。每个接口文档可以快速生成多个不同状态(成功、失败)的测试用例。
![](/assets/blank.gif)
对测试步骤进行编排,模拟业务情景设置测试流程控制条件(循环、判断、等待):
![](/assets/blank.gif)
了解更多自动生成文档的方法。
- 自动生成 API 文档 - Flask 项目实现
- 如何使用 Swagger 自动生成 API 文档
如何自动生成 API 接口文档 - 一份详细指南相关推荐
- python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- Laravel使用Apidoc注解自动生成Api接口文档
本教程从零开始搭建laravel项目,并安装Apidoc扩展及使用注解生成Api接口文档的教程,该扩展支持 多应用/版本.Markdown文档.在线接口调试.接口生成器.代码模板生成器.Mock调试数 ...
- coreapi自动生成API接口文档
文章目录 1 安装: 2 在路由中配置 视图中使用方法 1 安装: pip install coreapi 2 在路由中配置 from rest_framework.documentation imp ...
- Spring MVC学习总结(9)——Spring MVC整合swagger自动生成api接口文档
Swagger 号称:世界最流行的API框架,官网:http://swagger.io/,Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总 ...
- apidoc 自动化生成 api接口文档
手写api接口太麻烦. 学习了apidoc自动生成接口文档,这边做一下整理 要用组件那就必须先安装 apidoc,做一下全局安装 npm install apidoc -g 新建配置文件apidoc. ...
- 自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言 当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
- 开发日记-20190328 关键词 利用eolinker一键快速生成API接口文档
今天感觉效率真的很低= =各个层面的,apk发布到现场发现出现了问题,所以一个下午都在忙着解决现场出现的问题,领导一直打电话询问进度,午觉也没有睡所以今天预计的很多计划都处于停滞状态,像昨天规划的今天 ...
- Laravel使用swagger PHP生成api接口文档
Laravel使用swagger PHP生成api接口文档 Swagger集接口文档和测试于一体,就类比将postman和showdoc的结合体 首先要先安装基于laravel5的swagger包 地 ...
最新文章
- 英特尔AI芯片首次商用交货!推理性能3.7倍于英伟达T4,年贡献245亿涨250%
- coreData使用
- 网络边缘(接入网和物理介质)
- spring使用注解@Scheduled执行定时任务
- 【转】js 获取浏览器高度和宽度值(多浏览器
- 气是能量的宏观运行的现象描述
- C++中#includeXXX.h和#includeXXX.h的区别
- python 网格搜索_Python机器学习笔记:Grid SearchCV(网格搜索)
- QQ音乐API爬取全过程
- 经典网络结构 (五):ResNet (残差网络)
- 嵌入式 C 语言(上)
- 微信小程序图片上传至mysql数据库
- 高效能人士的7个习惯
- IC基础知识(十五)RS触发器、JK触发器、D触发器、T触发器
- SAP 查询物料的非限制库存、质检库存、冻结库存
- sql server操作1:数据库及基本表的建立
- 保镖机器人作文_保镖小学生作文
- 第一章 | 加州房价数据集 | 端到端的机器学习 | 回归问题 | tensorflow2.6+sklearn | 学习笔记
- 转转代扣“支付通道费”被“放大”背后,二手交易的命门是什么?
- 小杜机器人线下店_小度首家官方体验店开业啦!线下体验小度系列产品 智能家居任你玩...
热门文章
- Siamese目标跟踪:STMTrack: Template-free Visual Tracking with Space-time Memory Networks(CVPR2021)
- java最大子序列和问题_一文看懂《最大子序列和问题》(内含Java,Python,JS代码)...
- 2021年天津专升本文化课考试真题试卷及参考答案
- 工业互联网规模化扩展窗口期已至,如何抓住机遇超越发展?
- Vue-scoped
- matlab 2011a 下载,MATLAB 2011a(7.12) for Windows and Unix下载链接(Download Link)
- 企业级应用的概念和特点
- js判断数据类型常用的6种方法
- ubuntu16.04 有线网络不稳定解决办法
- Win7怎么通过任务管理器查看进程PID标识符MySQL安装时出现端口异常,提示The specified port already in usemysql error:Access deni