2023-07-04 17:15

功能强大的国产Api管理工具ApiFox

王姐姐

JavaEE

(1645)

(0)

前言

如果你是一名Java后端开发工程师像Swagger、Postman、RAP这些工具应该再熟悉不过了吧为我们的接口开发工作带来了很多的便捷不过因为这些都是独立的框架之间并不存在互通性因此在多个框架间协调的时候不可避免的会带来一些重复性的工作

今天来介绍一款强大的国产工具Apifox将Swagger 、 Postman 、 RAP 、 JMeter 的功能完美的做了整合一款工具全部搞定。

什么是Apifox

Apifox = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试。

常见的接口管理方案
API文档 Swagger

调试 APIPostman

Mock API 数据 RAP

API 自动化测试 JMeter

Apifox产生的初衷是为了提高研发团队各个角色的效率产品的使用受众为由前端开发、后端开发和测试人员以及技术经理组成的整个研发技术团队。

Apifox通过协作功能将研发团队的每个角色整合打通。

功能

接口设计 Apifox 接口文档遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 规范的同时提供了非常好用的可视化文档管理功能零学习成本非常高效。并且支持在线分享接口文档。
数据模型 可复用的数据结构定义接口返回数据结构及请求参数数据结构仅 JSON 和 XML
模式时可直接引用。支持模型直接嵌套引用直接 JSON/XML 智能导入支持 oneOf、allOf 等高级组合模式。
接口调试 Postman 有的功能比如环境变量、前置/后置脚本、Cookie/Session 全局共享等功能Apifox都有并且比 Postman更高效好用。接口运行完之后点击保存为用例按钮即可生成接口用例后续可直接运行接口用例无需再输入参数非常方便。自定义脚本 100%兼容 Postman 语法并且支持运行javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各种语言代码。
接口用例 通常一个接口会有多种情况用例比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性用接口用例来调试接口非常高效。
接口数据 Mock 内置 Mock.js 规则引擎非常方便 mock 出各种数据并且可以在定义数据结构的同时写好 mock规则。支持添加“期望”根据请求参数返回不同 mock 数据。最重要的是 Apifox 零配置即可 Mock出非常人性化的数据具体在本文后面介绍。
数据库操作 支持读取数据库数据作为接口请求参数使用。支持读取数据库数据用来校验(断言)接口请求是否成功。
接口自动化测试 提供接口集合测试可以通过选择接口或接口用例快速创建测试集。目前接口自动化测试更多功能还在开发中敬请期待目标是JMeter有的功能基本都会有并且要更好用。
快捷调试 类似 Postman 的接口调试方式主要用途为临时调试一些无需文档化的接口无需提前定义接口即可快速调试。
代码生成 根据接口及数据数据模型定义系统自动生成接口请求代码、前端业务代码及后端业务代码。
团队协作 Apifox 天生就是为团队协作而生的接口云端实时同步更新成熟的团队/项目/成员权限管理满足各类企业的需求。

使用

API接口使用

发送HTTP请求

API界面功能布局

在这里插入图片描述

API请求参数

Header和cookie参数
你可以设置或者导入 Header 参数cookie也可以进行设置
在这里插入图片描述
Query 参数
Query 支持构造URL参数同时支持 RESTful 的 PATH 参数如:id

Body 参数
Body 提供三种类型 form-data / x-www-form-urlencoded / raw 每种类型提供三种不同的UI界面

当你需要提交表单时切换到 x-www-form-urlencoded

在这里插入图片描述

当你需要提交有文件的表单时切换到 form-data
当您需要发送JSON对象或者其他对象时切换到对应的raw类型即可

API 请求响应

点击发送按钮后如果有数据返回则会显示返回数据响应时间响应码Cookie等。
在这里插入图片描述
注意返回数据默认是Pretty模式便于查看 JSON XML 格式。您可以通过切换原生或预览模式查看其它类型的类型。

返回Headers

在这里插入图片描述

设置全局参数

这里要提醒一下这个全局参数的设置我也是找了好久才发现。藏得有点深主要是功能太多了哈哈。

在这里插入图片描述
这里还可以设置测试环境、全局环境、全局变量、本地mock、云端mock等功能齐全十分强大。

一键生成文档

生成文档

新建接口
在这里插入图片描述
设置接口信息

设置好直接保存

接口文档一体化

这里修改接口就直接修改了文档十分方便。修改文档和接口能实时同步更新到调用这个开放API的所有开发者避免了项目接口升级或迭代需要很多的沟通和告知工作。
在这里插入图片描述

文档导出

在这里插入图片描述

导入postman\swagger文档

在接口管理处可以添加导入文档
在这里插入图片描述

支持导入 OpenApi (Swagger)、Postman、apiDoc、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost 、Apizza 、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery等数据格式方便旧项目迁移。

支持定时自动导入OpenApi (Swagger)、apiDoc、Apifox格式数据。
在这里插入图片描述

在线分享文档

可以将自己编写好的接口分享给其他成员也可以设置好我们的访问密码、过期时间等点击项目概览=》新建分享
在这里插入图片描述

Mock

大部分企业的产品都采用的敏捷开发为了能保证多端同步开展当方案一旦确定就需要通过Mock生成API的数据规则这样多端就可以根据文档规则进行开发不会因为团队见彼此的进度而互相干扰、互相影响。

编写Mock 规则

在这里插入图片描述
在APIfox中Mock 规则模板支持类型丰富
基本数据(固定json结构)

Java

{
  "code": "0",
  "data": {
    "name": "张三丰",
    "age": 100
  },
  "desc": "成功"}

基本数据(Mock随机json结构)

Java

{
  "code": "0",
  "data": {
    "list|20": [{
      "name": "@name",
      "age": "@integer(2)"
    }],
    "url": "https://localhost/create"
  },
  "desc": "成功"}

RESTFUL逻辑数据
某些场景中我们可能需要根据接口的入参规则加入适当的逻辑处理后再返回数据。一个简单的场景就是登录场景需要根据用户名密码判断是否登录成功。再或者我们需要根据产品ID动态返回产品信息等等。

现在Apifox 的Mock 服务提供了这种场景的解决方案。
以下示例中我们用到了 _req.body对象其含义是

当 post 请求以 x-www-form-urlencoded 或者application/json 方式提交时我们可以拿到请求的参数对象。

Java

{  "code": "0000",  "data": {    "verifySuccess": function() {      let body = _req.body;      return body.username === 'admin' && body.password === '123456';    },    "userInfo": function() {      let body = _req.body;      if (body.username === 'admin' && body.password === '123456') {        return Mock.mock({          username: "admin",          email: "@email",          address: "@address"        });      } else {        return null;      }    },  },  "desc": "成功"}