接口设计 (接口文档)
接口设计即定义接口文档规范(如接口路径、参数、返回值、数据结构等)。
接口调试 / 接口用例
设计好接口文档后,就可以直接 运行 接口来调试了。
调试模式
在项目开发初期,考虑到交付速度,开发人员会在制定业务需求之后直接进行代码开发,最终再通过代码生成 API 文档,即Code First。而基于这种场景考虑,我们推出了调试模式。
前置操作/后置操作
3 个项目
数据结构 / 数据模型
数据结构
快捷请求
使用场景
环境管理
一个项目在不同的阶段会处于不同的环境中,比如开发环境、测试环境、生产环境,通常不同的环境有不同的前置 URL、接口参数值等。因环境不同而频繁的更改接口前置 URL 及参数,是非常的麻烦的。 Apifox 的环境管理功能,只需在不同的环境设置不同的前置 URL 及参数,在不同环境中测试时,直接切换环境即可。
环境变量 / 全局变量 / 临时变量
和编程语言类似,变量是允许在多个地方重复使用的值。不同的接口用例(请求参数、脚本等)可以引用相同的变量值,只需要更改一次变量值,就能改变所有引用了该变量的相关值。使用变量可以大幅提升工作效率。
动态变量 / 随机参数
动态变量是在接口运行中,参数的值按照指定规则生成的变量。
接口修改历史
为了更好的支持团队协作的场景,在 2.2.18 之后的版本中,新增 接口修改历史 功能。
自定义字段
自定义字段功能,可以支持到项目管理者,可以根据自己的需要,设置接口文档的通用字段,比如:创建时间、TAPD 链接、需求文档链接等,更方便的管理项目
接口唯一标识
目前大多数接口是通过 method & path 来区分接口。而有的开发项目(例如一些电商 API 文档),接口请求的 URL 是不变的,通过 Query / Header 中的参数来区分接口。
接口批量管理
为了提高接口管理的能力,在 2.2.19 之后的版本中,新增 接口批量管理 功能。
语言设置
为了更好的支持国际化团队的开发工作,我们提供 3 种维度的语言设置
WebSocket 接口
WebSocket 是一种在单个 TCP 连接上进行全双工通信的 API 技术。相比于传统的 HTTP 请求,WebSocket 具有更低的延迟和更高的效率。它适用于需要长时间保持连接并实时传输数据的场景,例如在线游戏、实时聊天等。
WebService 接口示例
详情请看 WebService 接口示例
SOAP / WSDL 示例
详情请看 SOAP / WSDL 示例