文章目录
三、ApiFox 在企业中的利用 前后端拆散开发利器
partly_sunny:需要剖析
snowman:设计接口 编写代码
hourglass_flowing_sand:导入文档
四、在线生成代码提高效率
recycle:在线生成我的项目源代码,直呼 YYDS!
hotsprings:接口申请代码 一应俱全
一、什么是ApiFox?
Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化合作平台,定位 Postman + Swagger + Mock + JMeter
。通过一套零碎、一份数据,解决多个零碎之间的数据同步问题。只有定义好 API 文档,API 调试、API 数据 Mock、API 自动化测试就能够间接应用,无需再次定义;API 文档和 API 开发调试应用同一个工具,API 调试实现后即可保障和 API 文档定义完全一致。高效、及时、精确!
一句话概括:ApiFox = Postman + Swagger + Mock + JMeter
,开发利器!
二、ApiFox的益处
Apifox的劣势在于它能主动对A pi 进行更新和保护,使得我的项目接口的新增和变更能同步到我的项目所有成员中,防止数据不同步和沟通不及时带来的麻烦;使得测试人员毋庸重建新我的项目或手动导入更新局部, 缩小了不必要的工作量
API 文档设计
- 可视化 API 文档治理,零学习老本。
- 反对数据模型,接口之间能够复用雷同数据结构。
- 接口文档齐全遵循 OpenAPI(Swagger) 标准。
- 反对在线分享 API 文档,不便与内部团队合作。
API 调试
- Postman 有的性能 Apifox 都有(如环境变量、前置/后置脚本、Cookie/Session 全局共享等),并且比 Postman 更高效好用。
- 主动校验数据结构:校验返回的数据结构是否合乎文档定义,主动发现接口数据异样。
- 可视化的断言、提取变量、数据库(SQL)操作等性能。
- 反对接口用例性能(一个接口多个用例)。
更多ApiFox的劣势,移步官网查看 ApiFox 官网
PostMan 比照 国产化测试工具 Apifox
导入数据
- PostMan 不反对导入数据
- ApiFox 反对导入PostMan数据、等多种格局数据
测试接口
- PostMan 测试接口,有时可能会呈现提早状况,打不开软件,文档难以保护
- ApiFox 一体化测试 ,速度快,效率高,可一键导出接口文档,利于前期的开发保护
三、ApiFox 在企业中的利用 前后端拆散开发利器
需要剖析
需要:应用SpringBoot + Swagger 实现接口开发,具体要求如下:
- 实现信息接口的开发
- 导出文档,提供接口文档
- 采纳ApiFox 实现需要开发
我的项目环境 为 微服务项目,后续我会提供相干我的项目
我的项目构造如下:
设计接口 编写代码
ApiFoxController
package com.chen.controller;import com.chen.common.ResultBean;import io.jsonwebtoken.impl.crypto.MacProvider;import org.springframework.web.bind.annotation.CrossOrigin;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;import java.util.HashMap;import java.util.Map;@RestController@CrossOrigin@RequestMapping("/apifox")public class ApiFoxController { @PostMapping("/test") public ResultBean<Map<String, Object>> test() { Map<String, Object> map = new HashMap<>(); map.put("ApiFox", "YYDS!!!"); return ResultBean.create(0, "success", map); }}
接口编写结束,接下来咱们对接口进行测试
测试接口
下载[ApiFox]http://apifox.cn/a1csdbbug)
下载桌面版本64位即可,具体情况依据电脑来下载
清爽的UI界面,很难受~
新建我的项目
进入我的项目
整体我的项目工作台
治理环境
上面咱们新建一个快捷申请,申请刚刚编写的接口,看看返回的后果
生成接口文档
点击右上保留接口
填写接口相干信息
胜利生成接口
生成接口如此不便~ 真香!
四、ApiFox 更多功能
导入文档
我的项目设置 – > 导入数据 --> 抉择URL导入 --> 输出 url --> 点击提交即可
提交后如下界面
导入胜利
查看主页接口已导入胜利
导入胜利~ 如此快捷!
导出文档
点击接口后的 … ,期待下拉菜单呈现 点击导出
抉择想要的格局,导出
五、在线生成代码提高效率
在线生成我的项目源代码,直呼 YYDS!
性能阐明
依据接口模型定义,主动生成各种语言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等 130 种语言及框架)的业务代码(如 Model、Controller、单元测试代码等)和接口申请代码。目前 Apifox 反对 130 种语言及框架的代码主动生成。
更重要的是:你能够通过 自定义代码模板
来生成合乎本人团队的架构标准的代码,满足各种个性化的需要。
装置插件
关上 生成代码
面板,点击 装置插件
即可主动下载并装置。
装置Java环境
运行代码生成插件须要 Java 环境。请查看 装置 Java 环境
生成代码
获取apifox接口生成代码
关上后,炫酷的生成页面迎面而来
点击按钮 下载代码生成插件
生成Spring代码即可
生成我的项目目录
接口申请代码 一应俱全
查看接口申请代码,无需手写,间接复制即可调用接口
该页面蕴含了大部分的网络接口申请,真的很香~