什么是Apifox:Apifox = Postman + Swagger + Mock + JMeter

130 阅读3分钟

1.什么是接口文档

项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。

2.为什么要写接口文档

1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2、项目维护中或者项目人员更迭,方便后期人员查看、维护

3.Apifox的工具优势

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

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

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

  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.Apifox具体功能

1.可视化文档功能

image.png

2.数据模型

image.png

3.多格式导出数据

image.png

4.自动生成代码

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

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

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

image.png

4.IDEA插件Apifox

1.插件简单介绍

该插件主要用于 IDEA 项目快速生成 API 文档,并同步到 Apifox,代码零入侵

  • 基于 javadoc(Java)、KDoc(Kotlin)、ScalaDoc(Scala) 解析API文档。
  • 支持 Swagger 注解
  • 注意:可以在保持代码零侵入的情况下得到相当完整的 API 文档,但是特殊的需求还是需要部分特殊的注释/注解配合

2.功能特性

  • 导出 API 文档到 Apifox
  • 导出 Markdown 格式 API 文档
  • 在 IDEA 中直接发起 API 请求

3.安装插件

image.png

4.效果

Apifox插件还有一个非常牛逼的功能就是支持在 IDEA 中一键发起接口自测,不需要切换其他软件。

在 IDEA 中选中需要调试的 API 文件,右键选择 Call API

image.png 之后就可以在IDEA直接调试接口了

image.png