Apifox使用学习

news2024/9/22 19:45:18

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

只需要定义好API文档,API调试、API数据Mock、API自动化测试就可以直接使用。

API文档和API开发测试使用同一个工具,API调试完成后即可保证和API文档定义的一致性。

Apifox 是区分接口设计接口运行两个概念的。

  • 接口设计:即 新建接口 界面或接口详情里的 编辑 界面,用途是 定义接口文档规范,而不是 运行 接口,所以该界面是只能定义接口基本信息、参数名及参数说明等,而不能设置参数值参数值前置脚本/后置脚本 等信息请在接口运行界面或接口用例界面填写。
  • 接口运行:即接口详情里的 运行 界面,用途是 临时调试接口运行 完后,需要点击保存为用例,才能将填写的 参数值前置脚本/后置脚本 等信息保存下来;否则关闭 tab 后,这些信息将会丢失。

一、下载

官网:Apifox - API 文档、调试、Mock、测试一体化协作平台。拥有接口文档管理、接口调试、Mock、自动化测试等功能,接口开发、测试、联调效率,提升 10 倍。最好用的接口文档管理工具,接口自动化测试工具。Apifox = Postman + Swagger + Mock + JMeter。集接口文档工具、接口Mock工具、接口自动化测试工具、接口调试工具于一体,提升 10 倍研发效率。是最好用的API文档工具,API自动化测试工具,API Mock工具,接口文档管理工具,接口文档生成工具。icon-default.png?t=N7T8https://apifox.com/

二、接口文档设计

新建接口:

定义接口文档规范:

定义接口路径、基本信息、参数名及参数说明,不能设置参数值。

接口路径:

        不要包含http协议及域名,这部分在“环境管理”-“前置URL”中设置

        Path参数以大括号{}包裹起来;如获取用户信息/future/member/{menber_id}/info

        不可包含Query参数(即url?后的参数),在下方“请求参数”填写

请求参数:

        Params参数:包含Query参数和Path参数两部分

        Body参数:none、form-data、x-www-form-urlencoded、json、xml、binary、raw

                类型为json或xml,需设置数据结构,数据结构可以引用数据模型。

                接口发送请求时,会根据该设置自动在header加上对应Content-Type,无需手动

                设置

        Header、Cookie、Auth等

        示例值

返回响应:

        接口返回的HTTP状态码

        返回内容的数据格式:JSON、XML、HTML、Raw、Binary

        数据结构:仅JSON、XML可配置数据结构

当一个接口不同不同情况返回不同数据结构时,可设置多个返回响应

公共响应:

        主要用于实现返回响应的复用,通常不同接口在某些情况下会返回相同的数据结构,如资源不存在(404)、服务器错误(500)等,可设置公共响应,避免重复编写,方便统一管理。

响应示例:

        方便查阅接口文档的人快速了解数据结构。示例数据可设置多个:成功案例、

        失败案例。

环境管理:

        前置URL:接口运行时自动添加到接口路径前组成接口实际请求URL。

                尾部不要加上反斜杠/

        服务:当且仅当同一”环境“下,多个接口使用不同的”前置URL“时,才需要添加多个服务

        环境变量:跟随环境切换而发生改变的变量

数据结构/数据模型:

        数据结构:

        主要使用在【接口设计】的返回响应和json/xml类型的Body参数。支持增删改、拖拽。

                json/xml智能识别/快捷导入:已有JSON数据,导入后自动识别快捷生成。

                预览:根据设计的数据结构,mock出假数据,方便查看数据结构的实际效果

                生成代码:根据数据结构生成各种语言的代码

        数据模型:

                可复用的数据结构,根据项目需求,需新建,再引用。

在线分享:

        定义好的API文档,可通过在线文档分享。在线文档支持与运行调试、修改环境变量。

导入:

        支持多种数据格式的导入,方便项目迁移。导入可选的内容包括:接口

数据抓包:

在网页点击【F12】-【网络】

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2101565.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

PPT图表制作不再难!这款在线PPT软件让办公更简单!

ppt图表怎么制作? 在当下注重视觉呈现的数字化时代,有效的信息传递和数据可视化变得越来越重要。不管是商业演示、学术报告还是项目汇报,一份精心制作的PPT演示文稿,往往能够起到事半功倍的效果。其中,图表作为PPT中不…

n*n矩阵,输出矩阵中任意两点之间所有路径

题目1:给你一个正整数n, 构造一个n*n的四项链表矩阵。 要求: 1.使用四项链表 2.矩阵从左到右,从上到下值依次为1,2,3,4,......n*n 题目2:基于题目1, 在n*n链表矩阵中,输出矩阵中任意两点之间所有…

5款文案自动生成器,高质量创意文案一键为你生成

在当今竞争激烈的内容创作领域,每一个字、每一句话都承载着巨大的价值。对于创作者而言,文案自动生成器的出现,犹如在茫茫大海中点亮了一座指引方向的灯塔。它们不仅为创作者节省了宝贵的时间和精力,更像是一把神奇的钥匙&#xf…

5.4树,森林

5.4.1树的存储结构 可采用顺序存储结构or链式存储结构 要求能唯一的反映树中各节点之间的逻辑 1.双亲表示法 采用一端连续的空间来存储,同时在每个节点中增设一个伪指针,指示双亲节点在数组中的下标 优点:找双亲节点方便,找孩子不方便 attention:由于根节点无双亲节点,所以…

C++:关于反向迭代器的学习分享

前言: 小编仅是一位初学者,所以对于C的理解有限,文章大概率会出现表达不清楚可能也只是因为小编不知道如何更好表达,本文章仅作为一个学习的总结分享。 反向迭代器的概念 反向迭代器故名思意解释反向的迭代器,与正向迭…

地铁X光危险品检测数据集

地铁X光危险品检测数据集介绍 数据集概览 本数据集旨在为地铁X光安检系统提供高质量的危险品检测训练素材。数据集包含18类常见危险品,总共6265张图像,每张图像均经过精心标注,确保了数据的质量和一致性。数据集适用于多种格式(Y…

Spring优缺点和SpringBoot基础和搭建

前言 Spring框架是一个流行的Java企业级开发框架,旨在简化应用程序开发。它的核心特性包括依赖注入和面向切面编程,提供了灵活性和强大的社区支持。然而,Spring也存在学习曲线陡峭和配置复杂等缺点。 Spring Boot是基于Spring的项目&#x…

2024年高教社杯数学建模竞赛须知——三大注意事项

为了让大家在最后一天更好的备注国赛,我们今日将结合2024年国赛的新规给大家讲解国赛中三大主要的事项: 论文模版问题——国赛乃至大部分数模竞赛从来没有给出任何的论文模版,大部分的模版均为一次又一次学生、老师内部传播形成。资料使用问…

文件包含PHP伪协议利用方法

首先我们需要把配置文件php.ini 在 php.ini ⾥有两个重要的参数 allow_url_fopen 、allow_url_include; allow_url_fopen:默认值是 ON。允许 url ⾥的封装协议访问⽂件; allow_url_include:默认值是 OFF。不允许包含 url ⾥的封装协议包含⽂件&#x…

深度学习-VGG16原理和代码详解

VGG16 原理和代码详解 VGG16 是由牛津大学的 Visual Geometry Group (VGG) 提出的深度卷积神经网络,发表于 2014 年的论文 “Very Deep Convolutional Networks for Large-Scale Image Recognition”。VGG16 是其中的一种结构,由 16 层网络组成&#xf…

win系统安装mysql,使用mysqldump,pycharm使用mysqldump,避坑

文章目录 下载mysql的win客户端设置系统环境变量验证是否可用pycharm使用mysqldump异常问题排查 下载mysql的win客户端 官网下载地址如果下载旧版本,需自行到Archives里面找 本人使用的是mysql5.7,找到相应版本后,点击Download下载 设置系统…

Docker入门笔记

Docker 文章目录 Docker1. 下载 (centos)2. 部署 MySQL3. 常用命令4. 数据卷5. 自定义镜像6. Java 项目部署 1. 下载 (centos) 卸载旧版 yum remove docker \docker-client \docker-client-latest \docker-common \docker-lates…

个人旅游网(3)——功能详解——旅游路线功能

文章目录 一、旅游路线分类功能1.1、接口详解1.1.1、findAll 二、路线分类下的旅游路线功能2.2、接口详解2.2.1、findRouteListByCid 三、点击单条旅游路线查看其详情功能3.1、接口详解3.1.1、findRouteListByRid 四、分页功能4.1、导入依赖4.2、配置项的配置4.3、实现分页 一、…

Zotero tags(action and tags for zotero)怎么使用

先在下面的网址安装action and tags for zotero: https://github.com/windingwind/zotero-actions-tags 视频讲解: Zotero Tag -> Actions and Tags for Zotero - 远不止标签管理!_哔哩哔哩_bilibili 使用方法: 找到一些表情…

Linux驱动(四):Linux2.6字符设备驱动及GPIO子系统

目录 前言一、Linux2.6字符设备驱动的编写1.设备号2.注册设备号3.释放设备号4.核心结构体5.设备相关的 API 函数6.自动创建设备节点 二、GPIO 子系统1.申请所需gpio口资源2.释放gpio口资源3. 配置 gpio 口的工作模式4.获取gpio口的电平状态5.设置 gpio 的电平状态 三、目标实现…

路由引入(ospf+rip)

1.搭建拓扑图 2.配置接口ip地址

IO进程(线程篇)

知识点链接 https://www.yuque.com/aihenaobaijin/camuoq/lscmvf6z1arklau4?singleDoc# 《IO进程》 建议先学习知识点,再进行下面的练习 线程 概念 线程是一个轻量级的进程,为了提高系统的性能引入线程 线程和进程是参与统一的调度 在同一个进程中可…

【RSA】简单说说什么是RSA非对称加密

希望文章能给到你启发和灵感~ 如果觉得文章对你有帮助的话,点赞 关注 收藏 支持一下博主吧~ 阅读指南 开篇说明一、基础环境说明1.1 硬件环境1.2 软件环境 二、什么是非对称加密2.1 常见的非对称加密有哪些?2.2 哪些场景适合使用…

渗透测试靶机---- DC系列 DC-4

渗透测试靶机---- DC系列 DC-4 开启靶机,登录页面,平平无奇 扫描ip 端口,服务等信息 访问80 登录窗!!! 这里说明了admin信息,那么就直接爆破这个admin的密码 密码:happy 登录成功 在…

64位Office API声明语句第001讲

跟我学VBA,我这里专注VBA, 授人以渔。我98年开始,从源码接触VBA已经20余年了,随着年龄的增长,越来越觉得有必要把这项技能传递给需要这项技术的职场人员。希望职场和数据打交道的朋友,都来学习VBA,利用VBA,起码可以提高…