【Apifox Helper】自动生成接口文档，IDEA+Apifox懒人必备
@
前言
缘由
接口文档对接爽，整理起来真费脑
对于整理API文档，本狗秉承偷懒为上的原则，想找一种在IDEA中直接生成文档的方法。Apifox Helper绝绝子，只需要在IDEA中下载插件，无脑配置后，文档自动生成到Apifox，美完美解决。并且颜值及方便程度绝比Swagger和postman好太多。
⏲️本文阅读时长
约10分钟
前置条件
1. IDEA开发工具
2. Apifox(不必要)
主要目标
一秒生成接口文档
水图
IDEA中项目接结构图
想了解上图模块分层方法的同学，可以参考《还不会SpringBoot项目模块分层？来这手把手教你》
生成到Apifox接口文档图
试用人群
1. 像本狗一样【偷懒】不愿意整理接口文档
2. 学习新颖文档生成及管理方式
正文
1.在IDEA安装【Apifox Helper】插件
点击File=>Settings，找到Plugins,输入 Apifox Helper，点击安装，然后等待成功后重启IDEA,一定重启才会生效！！！
Tips: 你可以选择同步到 Apifox 项目中，也可以直接导出 markdown 文档。如果是同步到 Apifox 项目，你还需要下载或注册 Apifox 软件，并查看下面【Apifox Helper】的配置规则。如果不需要则只需要在项目中找到需要生成文档的Controller，右键后Export Markdown,直接导出apifox-api.md到对应目录。
打开apifox-api.md文件查看
2.修改【Apifox Helper】对应配置
点击File=>Settings=>Other Settings，找到 ApifoxHelper
1. Apifox服务器地址
2. API访问令牌
打开Apifox软件，点击左侧【头像】，点击【账号设置】，找到API访问令牌
点击新建令牌，填写名称及有效期，本狗填写名称为【IDEA专用】，有效期为【无限期】，点击【保存并生成令牌】
复制令牌到IDEA中【Apifox Helper】配置项的API访问令牌
3. 模块项目ID配置
打开Apifox软件，新建项目，本狗项目名为【bkb】,并确认
进入项目【bkb】，点击【项目设置】，点击【基本设置】，复制项目ID
将上述复制的【ProjectID】到IDEA中【Apifox Helper】配置【模块项目ID配置】，我的ModuleName为【bkb-boot-controller】，所以结构是bkb-boot-controller:xxxxx,点击【OK】
3.生成文档
右击【bkb-boot-controller】模块，点击 【Upload to Apifox】，等待完成即可
4.查看Apifox中自动生成的文档
一定要点击下Apifox软件右上角的刷新！
一定要点击下Apifox软件右上角的刷新！
一定要点击下Apifox软件右上角的刷新！
查看成果，大功告成，之后便可为所欲为了
写在最后
此生两悔，悔遇见你，更悔未早遇见你。
411天
【Apifox Helper】自动生成接口文档，IDEA+Apifox懒人必备的更多相关文章
- .net core 使用swagger自动生成接口文档
前言 swagger是一个api文档自动生动工具,还集成了在线调试. 可以为项目自动生成接口文档, 非常的方便快捷 Swashbuckle.AspNetCore 是一个开源项目,用于生成 ASP.N ...
- Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
- WebApi使用swagger ui自动生成接口文档
之前就写到.最近正在使用webapi.这里介绍一个实用的东西swageer ui现在开发都是前后端分开.我们这里是给前端提供api.有时候对于一个api的描述,并不想专门写一份文档.很浪费时间.swa ...
- drf07 过滤 排序 分页 异常处理 自动生成接口文档
4. 过滤Filtering 对于列表数据可能需要根据字段进行过滤,我们可以通过添加django-fitlter扩展来增强支持. pip install django-filter 在配置文件sett ...
- Spring Boot Swagger2自动生成接口文档
一.简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 1.问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 2 ...
- Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)
一.Django中的缓存: 前戏: 在动态网站中,用户所有的请求,服务器都会去数据库中进行相应的增,删,查,改,渲染模板,执行业务逻辑,最后生成用户看到的页面. 当一个网站的用户访问量很大的时候,每一 ...
- Django rest_framework 自动生成接口文档
自动生成接口文档 REST framework可以自动帮助我们生成接口文档. 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 1. 安装依赖 REST fram ...
- django自动生成接口文档
我们在实际项目中,会需要将我们的一些接口的信息返回给前端,便于前后端的交互,在实际使用中,这种自动生成接口文档的模块很多,我主要是用REST framework自动生成接口文档,这个需要用到的是cor ...
- drf频率源码、自动生成接口文档、JWT
目录 一.drf频率源码分析 二.自动生成接口文档 1 安装依赖 2 设置接口文档访问路径 3 文档描述说明的定义位置 4 访问接口文档网页 三.JWT 1 JWT基本原理 1.1 header 1. ...
- day74:drf:drf其他功能:认证/权限/限流/过滤/排序/分页/异常处理&自动生成接口文档
目录 1.django-admin 2.认证:Authentication 3.权限:Permissions 4.限流:Throttling 5.过滤:Filtering 6.排序:OrderingF ...
随机推荐
- js - console
js - console 参考资料 JavaScript Console 对象 Node.js console.debug()用法及代码示例 nodejs.org console.log输出字体颜色 ...
- react 学习笔记更新
生命周期 插槽 组件中间内容用this.props.children访问 是否组件更新 shouldcompontsupdata(props,newstatus){ return false: } 父 ...
- 关于C#高阶知识捡漏
高手掠过!仅仅是整理一下 自动属性: C#自动属性可以避免原来这样我们手工声明一个私有成员变量以及编写get/set逻辑 代码如下 //Demo: public class User { publi ...
- 生产者消费者demo
using System; using System.Collections.Generic; using System.Threading; namespace 生产者消费者 { class Pro ...
- 向excel中写数据的python代码
①首先需要安装xlwt插件 安装语句:pip install xlwt ②python代码 1 import xlwt 2 ''' 3 调用xlwt模块中的Workbook方法来创建一个excel表格 ...
- 微软开源 Python 自动化神器 Playwright
背景 逛博客时候突然看到 Playwright web自动化,感觉很有意思,就翻看了很多博客,简单记录一下. 简介 Playwright是一个强大的Python库,仅用一个API即可自动执行Chrom ...
- chatGpt启示
在应用软件领域实现自动化编程,我现在确实不怀疑了,只是还要等几年的问题.所以我的建议是:如果还想撸代码,可以往基础软件方向走,或者直接去大公司做 AI 工具:不想搞软件了,就去多了解业务吧.早做准备早 ...
- C# 数据结构和算法-数组队列
队列: 队列是一个有序列表,遵循先入先出原则,可以用数组或链表实现 使用场景 用于排队,按顺序执行 public static void Main(string[] args) { ArrayQueu ...
- 20220720 第七组 陈美娜 Java String用法
关于String引用数据类型 1.字符串中,两个变量的==指的是虚地址 2.String一旦声明不可改变:赋值进去,原值不会被替代.原值也可能指向其他地址: 3.s.length():字符的个数 4. ...
- 基础实验之access/trunk/valn/vlanif/静态路由
实验要求 1,PC1,PC2,PC3,PC4分别属于VLAN10,20,30,40 2,PC1,PC2,PC3,PC4互通 步骤1:PC1,2,3,4分别配置IP,并在SW6,SW7分别配置网关,并 ...