Apifox接口文档设计和调试教程【工具篇】

上一篇 / 下一篇  2022-06-09 14:52:08

一.Apifox的工具优势

对后端研发人员来说,Swagger+Postman 是接口设计和调试的必备工具,这两个工具都非常出色,

但不同系统间项目数据不互通,在变更、维护和协同上比较低效,另外是封装程度较低,使用上流程较为繁琐。

因此今天介绍一个 API 管理工具,一方面具备 Swagger 和 postman 的功能,一方面又针对上述问题做了优化,能够提升在工作过程中的效率。

二. Apifox 做的改进

1. Apifox的整体功能定位

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。Apifox = Postman + Swagger + Mock + JMeter.

对于后端同学,使用较多的是它的文档和调试功能,同时可通过其协作功能与前端和测试同学同步数据,减少沟通成本。

2.相对比于 Swagger 的优势

a.可视化的接口文档设计和管理界面,上手和使用成本低
b.设计好的接口文档能直接在Apifox 中调试,不需要再切换工具
c.接口和文档一体化,修改接口可同步修改文档,节省维护文档的精力
d. swagger 的核心功能 Apifox 基本都具备

3.相对比于 Postman 的优势

a.接口文档功能和调试功能一体,调试和修改文档能节省掉切换工具和系统间同步数据的成本
b. Postman 的调试功能 Apifox 都有
c. Apifox 对调试功能的支持更强大,支持连接数据库,调用第三方代码,可视化断言和提取接口变量

4.安装

复制链接粘贴到浏览器
官网直达www.apifox.cn

下面对Apifox 的核心 功能做一个简单的介绍

三. Apifox 功能介绍

1.项目导入导出功能

1.支持导出 OpenApi(Swagger)、 Markdown、 Html 等数据格式,因为可以导出 OpenApi格式数据,所以你可以利用 OpenApi (Swagger) 丰富的生态工具完成各种接口相关的事情。

2.支持导入 OpenApi(Swagger)、 Postman、 apiDoc、 HAR、 RAML、 RAP2、 YApi、 Eolinker、 ApiPost 、 Apizza 、 ShowDoc、 WADL等20多种数据格式,方便旧项目迁移。

3.支持定时自动导入 OpenApi(Swagger)、 apiDoc、 Apifox格式数据。

2.文档功能

2.1 可视化文档功能

  • API 文档支持编写 MarkDown格式的说明。
  • 支持 Markdown 所见即所得地编写非 API 文档的普通文档。
  • 设计好的 API 可一键生成美观的 API 文档。

2.2 数据模型可复用的数据结构,定义接口返回数据结构及请求参数数据结构(仅 JSON 和 XML 模式)时可直接引用。支持模型直接嵌套引用,直接 JSON/XML 智能导入,支持 oneOf、allOf 等高级组合模式。

2.3 生成在线文档分享

  • API 文档可导出为OpenAPI、Markdown、HTML等格式,方便离线分享。接口文档导出
  • API 文档支持密码保护和生效时间,可生成多份不同内容和权限的文档。

在线分享

生成的文档可以在浏览器打开,样式十分整洁美观

3. 调试功能

Postman 有的功能,比如环境变量、前置/后置脚本、Cookie/Session 全局共享 等功能,Apifox 都有

数据库操作:支持读取数据库数据,作为接口请求参数使用。支持读取数据库数据,用来校验(断言)接口请求是否成功。

自定义脚本: 100% 兼容 Postman 语法,并且支持运行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各种语言代码。

可视化断言前后置操作支持可视化设置断言,断言可处理响应 Json、响应 XML、响应 Header、耗时等多种对象,可断言是否等于、是否存在、是否包含、是否为空、正则匹配等逻辑。

提取变量前后置操作支持提取变量,可从可从接口返回结果里提取数据,设置到变量(临时变量/环境变量/全局变量),方便其他接口运行的时候直接使用。

4.自动生成代码

a.根据接口/模型定义,自动生成各种语言/框架的业务代码和 API 请求代码。

b.支持 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等 130 种语言及框架。

c.支持自定义代码模板,自动生成符合自己团队的架构规范的代码,满足各种个性化的需求

5.CI持续集成

  • 支持命令行方式运行 API 测试 (Apifox CLI)。
  • 支持集成 Jenkins 等持续集成工具。

6.协作功能

1.团队成员共用一套接口数据,任何变更都能及时同步到各端,减少沟通成本和数据不一致的问题
2.拥有人员权限管理功能,设置只读和编辑,可维护项目数据安全

7. Apifox的其他功能

1.智能mock
Apifox 内置智能 mock引擎,囊括常用的数据mock规则,不需要编写脚本就能mock出高度真实的业务数据供前端调试,同时支持用户自定义 mock 规则。

部分内置mock规则:

mock 出来的数据示例:

2.自动化测试

  • 支持引用 API 文档中定义的接口直接生成测试步骤。
  • 支持引用接口用例直接生成测试步骤。
  • 支持绑定接口,接口发生变化时,自动更新测试用例
  • 支持执行循环次数和用例之间设置时间间隔。
  • 测试用例支持参数动态值。
  • 支持自动生成测试报告

Apifox上测试步骤截图

Apifox上测试报告

四.免费下载

1.免费

这个软件SaaS版本官方已经承诺永久免费,只有私有化部署是付费的。而且SaaS版本不限接口数量,不限项目人数,不限功能,非常厚道,对于日常开发来说,SaaS版本已经完全够用了。

2.下载地址

复制链接粘贴到浏览器:

官网直达http://apifox.cn/a1liam11


TAG:

 

评分:0

我来说两句

日历

« 2022-11-28  
  12345
6789101112
13141516171819
20212223242526
27282930   

数据统计

  • 访问量: 12217
  • 日志数: 69
  • 建立时间: 2021-12-23
  • 更新时间: 2022-11-24

RSS订阅

Open Toolbar