代替swagger的api接口神器
自动化API文档-APIFOX
文章作者：老杨
一：概述
大家在后端开发开发过程中，最痛恨的两天事情：1.写文档，2.别人不写文档。而我们后端开发，必定经历的事情就是要和前端&测试对接，我们需要把我们的业务接口告知他们，让前端和测试能：1.并行开发，2.对接联调实现完整功能，3.测试根据接口完成测试用例编写和测试，所以避免不了的就需要我们出接口文档。我们出文档又回归到了三种方式：1.手工编写（任务给谁，谁骂），2.swagger，3.侵入式注解。
- 手工编写，如果是开发前定好接口，避免不了的设计不到位，后期重复修改，还有会占用前期大量时间，小团队耗不起。
- Swagger和侵入式注解，都需要在我们的代码中额外增加各种注解，对我们的代码可读性来说，点都不友好。
swagger嵌入式生成文档案例：
来吧，吐槽把。为什么我还要把逻辑代码和文档注解写在一个地方？这跟在 html 里写样式代码有什么区别？
来吧，上正题，今天给各位IT精英推荐ApiFox，JavaDoc和Idea插件一体化。解决你的烦恼问题，初步预计，这会成为业务未来主流，大家值得使用。
二：实操
- Apifox idea 插件--Apifox Helper
注：如果下载不下来，重试几次
这个插件用起来挺简单的，关键在于，它把从代码到 API 文档的这一步，用最方便的办法解决了。API 相关的定义再也不需要用侵入式的方式写到代码注解里，而是清清爽爽地写成像这样的注释就可以了。
注释里面的 @param, @link, @return 这些就是标准的 Javadoc 注释，在 JDK 里定义好的，全球通用。
只要写好了 Javadoc，自动生成 API 文档就只需要三步。
第一步，从 IDEA 插件市场下载 Apifox Helper，配置好你的 Apifox 令牌。
注：令牌到官网去微信关注登录，然后在
第二步，在 IDEA 里点右键，【Upload to Apifox】,就能一键从你的代码生成 API 文档。
Upload to Apifox可以生成单个接口，也能一键把 Controller 里面的所有接口全部生成！甚至把整个项目上右键一起生成接口文档。
第三步，在 Apifox 里面分享文档。我就拥有了一个方便的，美观的，可以团队协作的，还能在线调试的，完美的 API 文档。
到此，你就可以像使用Postman一样在这里完成接口的查阅，测试。nice！
三：经验总结
- 写完一个接口，首先自测，不着急上传到文档。可以在代码里点右键【Call API】，就可以直接在 IDEA 里发起接口请求，特别爽！根本不需要用 Postman！
- 自测没问题了就可以点右键【Upload to Apifox】，如果是新写的接口，就会在 Apifox 里新增一个 API；如果是原本的接口有修改，就会自动更新已有的 API。
- 把前端和测试的同事都直接加进 Apifox 的项目团队里。这样，只要我这边上传了 API，他们在 Apifox 里面直接就能看得见，根本不需要我发一个 API 文档给他们。API 文档不但自动生成了，开发人员我根本不需要管它！
- 前端和测试可以直接用 Apifox 来调接口和做测试。如果接口有调整，我就直接在代码里改，然后重新 Upload 一下，前端和测试那边看到的接口就是最新的了。
- 如果 API 需要开放给外部的合作团队，这个时候就需要专门输出一个 API 文档了。我在 Apifox 的“在线分享”选择开放给他们的接口，配上环境，就是一个完美的 API 文档了，还能在线直接运行和生成代码。
三方公司打开链接即可查看：
文章结束，如果喜欢的话请给个好评，你的鼓励是我最大的动力谢谢。
代替swagger的api接口神器相关推荐
- ABP学习实践(五)--引入Swagger对API接口进行管理
以目前流行的前后端分离模式来看,ABP框架更适用于后端开发,而对API接口的管理就成了一项必不可少的功能. 1.安装Swashbuckle.AspNetCore 使用Nuget管理器在分布式服务层和展 ...
- spring boot 集成springfox，使用swagger对 API 接口进行测试管理的 demo 示例
1. 描述 一个springboot项目集成 springfox 3.0,使用swagger对 API 接口进行测试管理的 demo示例. 环境: IDE(idea):2021.3 JDK:1.8 m ...
- .NET Core使用swagger进行API接口文档管理
一.问题背景 随着技术的发展,现在的开发模式已经更多的转向了前后端分离的模式,在前后端开发的过程中,联系的方式也变成了API接口,但是目前项目中对于API的管理很多时候还是通过手工编写文档,每次的需求 ...
- Spring Cloud Zuul中使用Swagger汇总API接口文档
有很多读者问过这样的一个问题: 虽然使用Swagger可以为Spring MVC编写的接口生成了API文档,但是在微服务化之后,这些API文档都离散在各个微服务中,是否有办法将这些接口都整合到一个文档 ...
- Spring Cloud Zuul中使用Swagger汇总API接口文档 1
有很多读者问过这样的一个问题:虽然使用Swagger可以为Spring MVC编写的接口生成了API文档,但是在微服务化之后,这些API文档都离散在各个微服务中,是否有办法将这些接口都整合到一个文档中 ...
- IDEA 版 API 接口神器来了，一键生成文档，嘎嘎香！
先看效果,这个文档就是通过该 IDEA 插件自动生成的,你能相信吗? 文档链接:https://petstore.apifox.cn 每个开发都不想写文档.当你不想写接口文档时,可以通过安装插件在 I ...
- ASP.NET Core WebApi构建API接口服务实战演练
一.ASP.NET Core WebApi课程介绍 人生苦短,我用.NET Core!提到Api接口,一般会想到以前用到的WebService和WCF服务,这三个技术都是用来创建服务接口,只不过Web ...
- 公司自用的国产API管理神器
1.前言 虚竹哥从事后端开发,平时写的后端接口,是以swagger生成API接口文档,提供给前端调用,与前端交互的文档:然后用Postman 自测接口,有些性能要求的接口会用JMeter 进行接口性能 ...
- SpringBoot——SpringBoot集成Swagger生成API文档
文章目录: 1.写在前面 2.步骤详解 2.1 pom文件中添加Swagger依赖 2.2 在application.properties核心配置文件中配置Swagger 2.3 编写需要生成API文 ...
最新文章
- 通过transpose和flip实现图像旋转90/180/270度
- 最热开源无服务器函数：五大Fission架构参考
- android 弹幕时间戳,【存档】B站直播数据包分析连载（2018-12-11更新/2020-04-12废止）...
- map赋值给另一个map_Java学习(十六): Lambda操作Map
- HCNA之网络基础【以太网帧结构】
- 分段概率密度矩估计_考研数学：高数、线代、概率3科目知识框架梳理
- 求一批整数中出现最多的个位数字_(43)C++面试之从1到n整数中1出现的次数
- TermuxArch安装java_高级终端Termux安装并使用
- windows 互斥量内核对象 Mutex
- Atitit springcloud的艺术 attilax总结 目录 1.1. 服务治理：Spring Cloud Eureka 39 注册中心 1 1.2. 第4章 客户端负载均衡：Spring
- wpsoffice 安装包_WPS office （安卓、ios) 企业版 软件介绍（附安装包）
- 第08课：GDB 实用调试技巧（ 上）
- AE+BodyMovin导出动画JSON文件
- 语音播报收款Java_Android实现收款成功金额的语音播报功能
- 【TL431】TL431精密电压调节器简介
- mysql 复制表结构或创建新表
- 20190408每周精品之理财
- 递归解九连环并且打印中间过程
- 雷军宣布小米支持鸿蒙,雷军宣布1080亿后！华为现金流被质疑！中兴、小米员工态度不同！...
- SciChart_V6.最新的图表控件发布了！