接口测试入门,接口文档的分析

1.首先最主要的就是要分析接口测试文档,每一个公司的测试文档都是不一样的。具体的就要根据自己公司的接口而定,里面缺少的内容自己需要与开发进行确认。

我认为一针对于测试而言的主要的接口测试文档应该包含的内容分为以下几个方面。

a.具体的一个业务实现的逻辑;

   b.请求的一个方式  例如:请求方式为(  http )                     http://127.0.0.1:8881/gasStation/process (http接口)

    c.反馈的一个方式,一般情况下http的反馈方式为json格式的(具体json格式书写大家了百度进行参考),一般情况下code返回200是正常情况,但是这个也要根据自公    司功能的一个反馈code码位标准。

   d.加密的方式(现在各个公司都是比较注重安全的,因此每个公司对数据的加密方式也是不一样的,例如现在市面上最流行的免费的加密编码工具就是base64)

e.之后就是每一个接口对应的一些规范

例如:     请求方法(常见的位POST(向服务器发送数据,相对于GET 而言,POST还是比较安全的)GET(从服务器获取数据))

      请求参数

       返回规范(返回值里面包含的内容或者有一条具体的返回示例)

这是一些我自己认为一份接口文档所需要的内容,后续有需要了,可以留言,我在进行补充,进行完善。

2.分析完了接口测试文档之后,我们需要根据接口文档来分析出做之前的一些预埋数据:所谓预埋数据就是做之前我们数据库里面必须存在的数据。

      例如:简单的一个示例:针对一个加油站的业务(模拟第三方向加油站发送请求数据,后续根据这些数据做一系列的操作)

例如:通过支付宝第三方平台,用户使用银行卡的绑定向加油站发送请求数据。绑定成功后加油站会返回一个唯一的表示服  userId进行后续的充值、消费、查询的业务。(通过这里可以判断出,我们作为加油站的测试人员要测试一个加油站的后续业务的一个正常使用流程为:绑定银行卡--充值--消费--查询)这里的预埋的数据就是需要:第三方平台编号,银行卡这两个字段数据库本身就应该是存在的。。

3.有了预埋数据后,则我们需要针对于每一个接口进行测试案例的编写

这个测试案例的编写和我们平时做的功能测试用例编写几乎是一样的(正常的流程操作,正案例和反案例),只是上传的参数不同。给大家举个简单的例子,但这个并不是一个完整的案例。

时间: 2024-10-14 23:53:45

接口测试入门,接口文档的分析的相关文章

springboot-使用OpenAPI之后我再也没有写过接口文档

一 前言 这篇文章主要是带大家入门下如何使用OpenAPI, 笔者在github上找到对应得swagger项目都没找到javase得人门文章,看了下是基于JAX-RS,吐血了: 二 什么是 OpenAPI, OpenAPI 是 一种基于Resful 风格 对 API进行格式化描述的一种规范: 允许你描述你整个项目的API,简单的讲就是一种接口文档生成的规范:包括如下几点 : 端点描述(如 GET /user , Post /user); 操作的参数,入输入参数,输出参数: 认证信息 联系信息,许

用Swagger生成接口文档

Swagger简介 在系统设计的时候,各个应用之间往往是通过接口进行交互的.因此接口的定义在整个团队中就变得尤为重要.我们可以把接口的规范用接口描述语言进行描述,然后Swagger可以根据我们定义的接口规范生成对应的接口文档.它生成的接口文档提供了接口测试功能.我们只需要填上对应的参数,然后点击调用,就可以完成一次接口测试,非常方便.就像下图展示的那样. 不仅如此,Swagger还能够根据接口规范自动生成对应的接口代码!比如Java客户端代码.Java服务端代码等.这个东西减少了接口规范的沟通成

[API]使用Blueprint来高雅的编写接口文档

Blueprint(http://apiary.io/)是apiary公司的工具包,用来编写API文档,类似于Markdown,是一种标记语言. 对于习惯使用RESTful API的同志们来说,使用Blueprint可以快速的写出高雅大气的文档: 下面以一个Github中的Gist服务为例,简单的演示一下Blueprint的应用. 原文地址:http://blog.callmewhy.com/2014/06/05/blueprint-tutorial/ API Blueprint是一套API描述

get_k_data 接口文档 全新的免费行情数据接口

get_k_data 接口文档 全新的免费行情数据接口 原创: Jimmy 挖地兔 2016-11-06 前言在tushareAPI里,曾经被用户喜欢和作为典范使用的API get_hist_data,经历了数据的一些些缺失和一丢丢错误之后,在用户们的齐声呼“换”之下,终于要变成tushare中的一个history.迎来的是一个集分钟数据.日周月数据,前后复权数据,揽括所有股票.指数和ETF的get_k_data.未来,还将加入期货期权等品种,所以,get_k_data或许将会成为未来一个“著名

利用ApiPost一键、快速生成接口文档!女猿也过38节!

对于我们这些程序员和程序媛来讲,最头疼的莫过于写文档. 我们可都是正个八经的理工校草和理工女神,研究github.逛逛csdn.写hello world是才我们的拿手菜,写文档是文科生的事情好不啦?(手动吐哇吐) 今天,教大家一个妙招:利用ApiPost一键.快速生成接口文档! 妈妈再也不用担心自己女孩纸们没有时间过38节啦! 当女程序媛遇到问题,那就不是问题 ApiPost简介: ApiPost是一个支持团队协作,并可直接生成文档的API调试.管理工具.它支持模拟POST.GET.PUT等常见

程序员不得的不会的接口文档

一.传统方式 众所周知,我们Java程序员在写完数据接口之后,想要前端或者App工程师调用的,需要写出接口文档,方便描述每一个接口都是干什么的,需要什么,怎么请求,返回的结果又是什么?可是现在的你是否还在手写接口文档呢?在手写接口文档中,有没有遇到,文档刚写好,测试反馈接口有问题,又不得不改写接口,结果接口改完之后,发送文档对不上了,怎么办? 我在工作中,是如何编写接口文档的呢?接下来给大家聊一神器,惊喜在后面. 首先,我新建一个项目,基于Spring Boot,开发几个接口,发布运行. 编写代

告别手写接口文档时代,比Swagger功能更强大的LKADocument接口文档管理框架诞生了!

更详细的更全面的教程请观看作者亲自录制的视频教程,地址: https://edu.51cto.com/sd/9cb7fLKADocument视频教程 一.介绍 在前后端分离,分工更加明细化的今天,为了减少前端和后台开发人员的沟通成本,能够让他们做到并行开发,同时也能保证前端和后端开发人员所看到的接口文档的一致性,即时性,以此来大大提高工作效率.所以出现了一些非常优秀的接口管理工具,具有代表性的像Swagger,因为它能够通过注解或yml和JSON描述文件来自动生成接口文档.但是我觉得它不管是在配

如何利用apidoc来写接口文档

在开发后台接口的过程中,肯定要提供一份api接口文档给终端.一直用word写,太丑了..怎么才能做出一份漂亮的api文档呢?找了好久发现了今天的主角-apidoc. 官网地址:http://apidocjs.com 开放API已经成为当下主流平台的一个要素,特别对于社交.电商类的平台开放API更成为了竞争力的一种.开放API文档的完整性.可阅读性往往影响着接入方是否能顺利地.快速地接入到平台,一份好的.统一的API文档也是开放平台不可或缺的要素. apidoc是通过源码中的注释来生成API文档,

附录1:接口文档参考模板

https://www.w3cschool.cn/phalapi/5fhi1tth.html 附录1:接口文档参考模板 由 chanzonghuang 创建,最后一次修改 2016-11-20 虽然提供了在线接口参数的查看,但在和客户端对接过程中,我们作为后台开发,还是需要人工提供接口文档给客户端的,这里提供一个接口文档编写的模板,以供参考,并且以我们熟悉的?service=User.GetBaseInfo为例说明如何编写高效的文档. 温馨提示:斜体字表示是注释说明. 功能说明 对接口功能的简单