软件测试之接口文档

软件设计之接口文档 在软件开发中,系统往往会有多个模块或组件之间相互依赖、相互调用的情况,而接口文档则是用来记录各个组件之间的交互方式、数据格式及其他细节信息。如我现在接手的软件缺陷开发系统中前后端数据要进行交接,前后端工程师必须有一个统一的文件进行沟通交流开发,方便数据的传输和调用,和方便后续项目人员进行更迭,查看、维护。接口文档是用于记录系统或软件中各个模块之间的交互方式及传递过程中所使用的数据格式等细节信息的文件或文档。 阅读详情

什么是接口文档?

在项目期间,前后端是分离开发的,为了前后有连贯性,就必须由前后开发工程师共同定义接口、写接口文档再根据接口文档去开发,一直到项目结束。

没有接口文档,想做接口测试的话,自己实践过以下2种方式:

1。 通过抓包的方式,根据业务流获取到对应的接口,然后整理成相关文档,如果有不清楚的字段,将问题汇总后找开发咨询,然后在进行接口测试。(抓包工具charles)

2。可以通过 jmeter 的代理录制功能,将接口逐一录制下来形成接口文档,然后再逐一进行接口测试。

一般在项目开发阶段,接口文档基本上是必备产物了,一般由后端开发人员提供,作为和前端人员进行前后端接口联调的桥梁,或者与别的项目模块进行交互提供指导等等,接口文档的准确性,实时性,详细与否等,都会极大的影响联调工作。(或者是开发推演阶段,开发会定好接口名称、入参、出参等,维护在接口文档里边,有更新的话,会及时通知相关人员)

目前经历过的公司,都会有接口文档,有差异的地方 就是平台不一样,常见的有swagger、DOClever、sosapi,如果面试过程中遇到该问题,上述的2种回答可供参考,另外可根据具体项目上的情况再聊聊。

接口文档规范

  • 方法

  也就是我们常写的新增,删除,修改,查询

  • url

  调用方法,一般是从前端调后端的方法地址

  • 请求参数

  一般分五列:字段、说明、类型、备注、是否必填 

  • 返回参数

  1、如果只返回接口调用成功还是失败(新增、删除、修改等),则只有一个结构体:

      code和message两个参数;

  2、如果要返回某些参数,则有两个结构体:

      是code/mesage/data;

        是data里写返回的参数,data是object类型;

  3、如果要返回列表,那么有三个结构体,

          是code/mesage/data,data是object,里面放置page/size/total/totalPage/list 5个参数,其中list是Arrary类型,list里放object,object里是具体的参数。

了解目的

  1. 用户登录
  2. 用户注册
  3. 树形菜单
  4. 文章查询
  5. 文章新增
  6. 文章修改
  7. 文章删除

用户登录:

  接口调用and请求

http请求方式: POST    (一般有两种get/post)
https://xxx.xxx.xxx:8080/项目命名/vue/userAction_login.action
字段说明类型是否必填
uname名字String是
pwd密码String是
登录成功返回JSON数据包:

{

"msg":"登录成功",

"result":{

"uname":"用户名",

"pwd":"密码"

},

"code":1

}

用户或者密码为空返回JSON数据包:


{

"msg":"用户或者密码为空",

"result":{

"uname":"用户名",

"pwd":"密码"

},

"code":0

}

用户或者密码错误返回JSON数据包:


{

"msg":"用户或者密码错误",

"result":{

"uname":"用户名",

"pwd":"密码"

},

"code":0

}

参数

说明

msg

提示消息

result

返回登录的用户名和密码

code

状态 0:登录失败 1:登录成功

用户注册

接口调用

https://xxx.xxx.xxx:8080/项目命名/vue/userAction_reg.action
字段说明类型是否必填
uname名字String是
pwd密码String是

注册返回JSON数据包:

{
    "msg":"用户注册成功",
    "code":1
}

用户注册失败返回JSON数据包:

{
    "msg":"用户注册失败",
    "code":0
}

参数

说明

msg

提示消息

code

状态码 0:失败 1:成功

树形菜单

调用接口

https://xxx.xxx.xxx:8080/项目命名/vue/treeNodeAction.action

返回的json数据表如下:


{

"msg": "操作成功",

"result": [

{

"treeNodeId": 1,

"treeNodeName": "系统管理",

"treeNodeType": 1,

"url": null,

"position": 1,

"icon": "el-icon-setting",

"children": [

{

"treeNodeId": 2,

"treeNodeName": "用户管理",

"treeNodeType": 2,

"url": "/sys/VuexPage1",

"position": 2,

"icon": "el-icon-user",

"children": []

},

{

"treeNodeId": 3,

"treeNodeName": "角色管理",

"treeNodeType": 2,

"url": "/sys/VuexPage2",

"position": 3,

"icon": "",

"children": []

},

{

"treeNodeId": 4,

"treeNodeName": "密码修改",

"treeNodeType": 2,

"url": null,

"position": 4,

"icon": null,

"children": []

}

]

},

{

"treeNodeId": 5,

"treeNodeName": "论坛管理",

"treeNodeType": 1,

"url": null,

"position": 5,

"icon": "el-icon-reading",

"children": [

{

"treeNodeId": 6,

"treeNodeName": "文章管理",

"treeNodeType": 2,

"url": "/sys/Articles",

"position": 6,

"icon": null,

"children": []

}

]

}

],

"code": 1

}

参数

说明

msg

提示消息

result

返回树形菜单结果集

code

状态 0:失败 1:成功

Result树形菜单结果集

参数

说明

treeNodeId

菜单id

treeNodeName

菜单名

treeNodeType

菜单类型 1:父菜单2:跳转菜单

url

路由地址

icon

菜单图标

children

子菜单集,如果没有则为一个空json数组

文章查询

调用接口

https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_list.action

参数

是否必填

说明

page

否

当前页码,默认为1

rows

否

一页展示多少条数据,默认为10

title

否

按文章标题查询

返回json数据包说明:


{

"result":[{"id":1,"title":"文章标题","body":"文章内容"],

"pageBean":{

"page":1,

"rows":10,

"total":100,

}

}

result结果集

参数

说明

id

文章id

title

文章标题

body

文章内容

pageBean 分页对象说明

参数

说明

page

当前页码

rows

一页展示的条数

total

总条数

文章添加

调用接口

https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_add.action

参数

是否必填

说明

title

是

文章标题

Body

否

文章内容

添加成功返回JSON数据包:

{"msg":"新增成功","result":[],"code":1}

添加失败返回JSON数据包:

{"msg":"新增失败","result":[],"code":0}

参数

说明

msg

提示消息

code

状态码 0:失败 1:成功

文章修改

调用接口

https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_edit.action

参数

是否必须

说明

id

是

文章id

title

否

文章标题

body

否

文章内容

修改成功返回JSON数据包:

{"msg":"修改成功","code":1}

修改失败返回JSON数据包:

{"msg":"修改失败","code":0}

参数

说明

msg

提示消息

code

状态码 0:失败 1:成功

文章删除

调用接口

https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_del.action

参数

是否必须

说明

id

是

文章id

删除成功返回JSON数据包:

{"msg":"删除成功","code":1}

删除失败返回JSON数据包:

{"msg":"删除失败","code":0}

参数

说明

msg

提示消息

code

状态码 0:失败 1:成功


这篇贴子到这里就结束了,最后,希望看这篇帖子的朋友能够有所收获。

最后作为一位过来人也是希望大家少走一些弯路,如果你不想再体验一次学习时找不到资料,没人解答问题,坚持几天便放弃的感受的话,在这里我给大家分享一些软件测试的学习资源,希望能给你前进的路上带来帮助。

​视频文档获取方式:
这份文档和视频资料,对于想从事【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴我走过了最艰难的路程,希望也能帮助到你!以上均可以分享,点下方小卡片即可自行领取。

全网最全的接口文档速成 当前项目中,前端代码和后端代码混合在一起,是存在问题的,存在什么问题呢?主要存在以下几点问题:1). 开发人员同时负责前端和后端代码开发,分工不明确2). 开发效率低3). 前后端代码混合在一个工程中,不便于管理4). 对开发人员要求高(既会前端,又会后端),人员招聘困难为了解决上述提到的问题,现在比较主流的开发方式,就是前后端分离开发,前端人员开发前端的代码,后端开发人员开发服务端的业务功能,分工明确,各司其职。我们本章节,就是需要将之前的项目进行优化改造,变成前后端分离开发的项目。 阅读详情

相关推荐

后端接口文档例子 word

word版接口文档

什么是接口文档

一、什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。 二、为什么要写接口文档? 1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 2、项目维护中或者项目人员更迭,方便后期人员查看、维护 三、接口规范是什么? 首先接口分为四部分:方法、uri、请求参数、返回参数 1、方法:新增(post) 修改(put) 删除(delete) 获取(get) 2、ur..

浮煌的博客 1万+

UDS诊断入门第一课:手把手教你玩转0x10会话控制服务(附ISO14229实战解析)

刚接触汽车电子诊断的工程师们,往往会被厚厚的ISO 14229标准文档和各种专业术语吓退。但就像学习编程要从"Hello World"开始一样,掌握UDS协议的最佳切入点就是0x10诊断会话控制服务。这个看似简单的服务,实际上是整个诊断系统的"钥匙"——它决定了ECU(电子控制单元)当前处于何种工作模式,直接影响着其他诊断服务的可用性。 在实际车辆诊断中,ECU默认处于DefaultSession模式,这种模式下许多高级诊断功能是被禁用的。想象一下你正在开发一个需要刷写ECU固件的工具,如果连最基本的会

weixin_30402343的博客 395

简单易懂,高效实用的接口文档编写技巧

接口文档是一个软件系统的重要组成部分,它描述了系统中所有可供外部应用程序使用的接口。简单来说,接口文档就是用来帮助开发者开发和对接系统的指南。

summon的博客 1万+

【中英双语】Illumina测序原理详解 | 边合成边测序/Sequencing by Synthesis

很多朋友们问我视频讲解时用的笔记可不可以分享,那当然必须是可以呐!但我当时其实没有好好记录,只是打了个草稿就开讲啦!既然大家有需求,俺就重新整理了一下,希望可以帮到大家!

weixin_43843918的博客 7877

2026 AI编程环境安装指南:从下载、部署到流式验证

AI编程环境已不再是传统软件安装,而是融合硬件兼容性、模型运行时与IDE插件协同的系统工程。其核心原理在于:本地GPU驱动需匹配量化运行时(如Ollama v0.3+对CUDA 12.1+的强制要求),协议层依赖gRPC流式响应,生态层则要求插件签名与模型源可信校验。这一技术组合显著提升AI代码生成的实时性与生产就绪度,支撑微服务开发、CI/CD智能补全、本地LLM推理等关键场景。本文聚焦AI编程软件下载与安装过程中的可复现部署实践,覆盖macOS/WSL2双平台、NVMe模型加速、离线校验及原子化功能验证

weixin_30480075的博客 599

软件测试最全怎么写一份好的接口文档?_做一个接口文档,2024年最新软件测试布局优化之include、merge、ViewStub的使用

编写一份优秀的接口文档需要考虑多个方面,包括清晰的结构、详细的参数说明、清晰明了的示例、详细的错误码说明、易于理解的语言以及及时的更新和维护。如果能遵循这些条件,那写出来的接口文档一定非常完美。但同时也要耗费更多的精力,但其实我们完全可以借助工具帮我们解决,比如我上文提到的 Apifox,虽然我最初使用这个软件是因为免费而且界面好看,但是用下来发现功能也是很能打的,而且它有一款 IDEA 插件,能自动解析代码注解生成接口文档,不要太方便好吗哈哈哈哈!文档真的很省心了!

2401_84715691的博客 736

伯德图详解:从传递函数到系统稳定性的频域分析

在自动控制与控制系统设计中,理解系统对不同频率输入信号的响应特性,是分析和设计稳定系统的核心基础。频率响应描述了系统对正弦输入的幅值增益与相位变化规律,而伯德图作为最直观的频域分析工具,通过对数坐标将宽频带特性压缩成一条清晰曲线,让工程师无需复杂计算即可快速评估系统性能。从典型环节的渐近线绘制,到相位裕度、幅值裕度的读取,伯德图贯穿了系统稳定性判断、控制器参数整定及噪声抑制等关键场景。本文结合实际调试经验,系统讲解伯德图的绘制原理与读图方法,帮助读者快速掌握从传递函数到工程应用的核心技能。

weixin_34535286的博客 344

根据接口文档开发_黑马程序员软件测试视频教程之接口测试全剖析

什么是接口文档?“接口文档”又称为“API文档”,一般是由开发人员所编写的,用来描述系统所提供接口信息的文档。大家都根据这个接口文档进行开发,并需要一直维护和遵守。为什么要写接口文档?1)能够让前端开发与后台开发人员更好的配合,提高工作效率2)项目迭代或者项目人员更迭时,方便后期人员查看和维护3)方便测试人员进行接口测试接口测试的类型有哪些?我们在做接口测试的时候通常是对普通的http协议接口进行...

weixin_39597262的博客 347

ADS124S08配置避坑指南:从SPI时序到寄存器设置,手把手教你调通24位ADC

本文详细解析了ADS124S08 24位ADC的SPI时序配置、寄存器设置及外围电路设计中的关键细节,帮助工程师避开常见陷阱。从SPI通信模式选择到DRDY引脚读取优化,再到基准电压启动时间调整,提供了实战验证的解决方案,确保高精度数据采集的稳定性。

weixin_29192365的博客 292

从 SM59 到 SPROXY,打通 ABAP 后端与 ES Repository 的代理生成链路

本文探讨了在SAP PI/PO项目中配置ABAP后端系统与ES Repository连接的关键步骤,重点解决ABAP Proxy生成时无法获取接口模型的问题。文章指出: 该配置本质是建立设计时通道,使ABAP系统能通过SPROXY访问ES Repository中的接口模型并生成代理类 配置核心是在SM59创建名为SAP_PROXY_ESR的HTTP连接(类型G),需确保: 目标路径为/rep 使用具备SAP_XI_IS_SERV_USER角色的服务账号 连接测试通过后仍需在SPROXY中验证完整功能 常见陷

2007 年 ~ 2025 年,深耕 SAP 技术 18 年 64

最全接口测试之什么是接口文档?(2),2024年最新软件测试高级工程师面试题

(注:一般这种提交参数的接口用post方式,虽然get也可以提交,但是比较傻逼,要是遇到开发用get方式提交数据,可以抽他了。用户账号&cpPwd=用户密码&phones=号码&msg=内容。用户账号&cpPwd=用户密码&phones=号码&msg=内容。‘content’:‘111【软件测试部落】’,‘content’:‘222【软件测试部落】’,HTTP请求方式:GET/POST。‘cpid’:‘您的用户名’,‘cppwd’:‘您的密码’,HTTP请求方式:POST。返回描述 String。

2301_82242351的博客 347

AI测试实战:手把手教你做LLM(大模型)性能测试「含完整代码」

大模型API性能测试是评估模型服务响应能力、吞吐量和资源效率的关键手段。核心指标包括总响应时间、吐字率、首token延迟、输入/输出tokens数量、QPM等。测试流程涵盖构造负载、并发请求、数据采集和指标计算。优化建议针对吐字率低、首token延迟高、QPM偏低等问题,从模型、硬件、系统等多层面提出解决方案。

blues_C的博客 1431

软件测试接口测试从入门到精通:如何阅读接口文档 - 测试人员的必备技能

接口文档 = 餐厅菜单菜单告诉你:- 有什么菜(有哪些接口)- 每道菜什么价格(需要什么参数)- 菜的口味描述(返回什么数据)- 需要等多久(响应时间要求)没有菜单,你就不知道餐厅有什么,怎么点菜。没有接口文档,你就不知道系统有什么接口,怎么测试。

lw的博客 613

精雕软件(JDpaint) 5.5 绿色版

精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版

android 蓝牙通讯demo

android 下蓝牙通讯demo,实现了发现蓝牙,使能蓝牙,通过蓝牙发送消息。

接口测试中如何处理开发是否提供接口文档

用的软件导出图片额度没了,先截图了,不清晰,大概看吧,从上面的图中可以看出,接口文档的提供具有一定的主观性,有些随意,不规范,也没有一定的约束,所以要想保证接口文档的有效性和规范性,首先应该从流程规范上面去约束,虽然google测试之道不推荐强流程和教条式的测试,但是国内目前的环境和大多技术人员的意识还没有达到像google那样的境界,没有流程规范,就不会自觉的去执行,久而久之,便会不了了之。在设计评审和代码评审的时候,就确认接口文档是否可用,是否完善,如果不完善,需要在评审结果中指明,补充完善接口文档。

2401_83014899的博客 648

STM32F407中文手册

STM32f407中文手册 本参考手册面向应用开发人员,提供有关使用 STM32F405xx/07xx、STM32F415xx/17xx、 STM32F42xxx 和 STM32F43xxx 微控制器存储器与外设的完整信息。STM32F405xx/07xx、STM32F415xx/17xx、STM32F42xxx 和 STM32F43xxx 构成一个微 控制器系列,各产品具有不同的存储器大小、封装和外设。有关订购信息以及器件的机械与电气特性,请参见数据手册。有关 ARM Cortex™-M4F 内核的信息,请参见《Cortex™-M4F 技术参考手册》。

软件测试最全接口测试之什么是接口文档?_测试接口文档是什么(5),我阿里P7了解到的软件测试面试的一些小内幕

没有接口文档的接口测试都是在抓瞎~前面的接口测试重点讲了协议,也讲了fiddler模拟接口请求,估计大部分还是不太懂怎么下手测试。· 双方通过HTTP方式交互数据,第三方可以简单的“name=value”方式发送提交内容或响应请求内容。· 另外双方需要保证数据传输的完整性和安全性,每次发送请求都有响应(响应返回格式为纯文本),安全验证目前采用用户名和密码的方式。(注:一般这种提交参数的接口用post方式,虽然get也可以提交,但是比较傻逼,要是遇到开发用get方式提交数据,可以抽他了。

egregw的博客 951

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术,以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索,主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式,计算机控制系统的数学描述与基本分析方法,以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

什么是接口文档,如何写接口,有什么规范?

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

nhb687096的博客 3806

在接口测试中怎么处理开发是否提供接口文档的总结

最近做了好几个项目的接口自动化,接口测试很重要的参考依据就是接口文档,在自动化实施过程中碰到的接口文档也是千差万别,有的项目没有接口文档,有的项目有接口文档,有接口文档的项目,有的很完善,有的不完善,有的没有和项目迭代保持最新,一直也没有对文档这一块做一个总结,导致工作中很容易发生漏测的情况。

软件测试技术分享官 208

接口测试之什么是接口文档?,小红书软件测试面试题目

(注:一般这种提交参数的接口用post方式,虽然get也可以提交,但是比较傻逼,要是遇到开发用get方式提交数据,可以抽他了。用户账号&cpPwd=用户密码&phones=号码&msg=内容。‘content’:‘111【软件测试部落】’,‘content’:‘222【软件测试部落】’,‘cpid’:‘您的用户名’,‘cppwd’:‘您的密码’,HTTP请求方式:POST。返回描述 String。参数名称 类型 描述。

2401_84247726的博客 525

接口文档要写在概要设计里吗_软件测试有前途吗?

随着人工智能时代的到来,IT行业受到了越来越多人的重视。软件测试作为把控软件质量必不可少的环节,其重要性可见一斑。那么从事软件测试行业究竟有前途吗?今天我们就来详细的介绍一下软件测试,看看软件测试这份工作到底怎么样?首先我们需要了解一下什么是软件测试?软件测试是做什么的?软件测试说白了其实就是找代码的bug,发现软件的错误。就是对开发人员提交的软件进行测试,模拟用户使用,发现问题。它是一个系列过程...

weixin_39914868的博客 260
上一篇: Python测试框架: ​封装pytest测试用例
下一篇: 性能测试混合业务场景
测试界萧萧
博客等级 码龄2年 5535粉丝 1018原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值