【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 ...
随机推荐
- 使用logback需要导入的jar包
jar包名 logback-access-1.1.2.jar logback-classic-1.1.2.jar logback-core-1.1.2.jar slf4j-api-1.7.25.jar ...
- Pytest Fixture（三）
name: name参数表示可以对fixture的名称进行重命名: 注意:通过name重命名后,继续使用以前的名字调用会报错. import pytest @pytest.fixture(name=' ...
- Java-String常用API
返回值类型 方法 用途 备注 char charAt(int index) 返回 char指定索引处的值. int compareTo(String anotherString) 按字典顺序比较两 ...
- CMD Debug大全
'service' 不是内部或外部命令,也不是可运行的程序 或批处理文件. 先看环境变量配置是否到位,再使用管理员运行cmd
- echo 操作
echo打印制表符到文件: MAP_PATH=/path/for i in `cat sp.list`; do echo -e "${MAP_PATH}/${i}.${i}/${i}.fin ...
- leetcode-560-和为 K 的子数组
给你一个整数数组 nums 和一个整数 k ,请你统计并返回 该数组中和为 k 的连续子数组的个数 . 示例 1: 输入:nums = [1,1,1], k = 2 输出:2 示例 2: 输入:num ...
- pyqt学习
- visio2019 破解
链接:https://pan.baidu.com/s/14AU8GFXhgjp87pK1bIK8UA?pwd=ju61 提取码:ju61 --来自百度网盘超级会员V5的分享 可能需要关闭防火墙和win ...
- 一招彻底解决——双系统下windows时间错误显示
双系统下windows与ubuntu系统时间不同步 我的笔电是windows系统,工作需要安装了ubuntu,于是成为双系统,于是从18年我就遇到了装了ubuntu系统之后windows时间显示错误的 ...
- requests模块之post请求传参json和data区别
post请求参数到底是传data还是json,此时要看请求头里的content-type类型 请求头中content-type为application/json, 为json形式,post请求使用js ...