接口测试相关文档

1.什么是接口文档？

在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档。

2.接口规范是什么？

分为四部分：请求方式，uri，请求参数，返回参数

请求方式：新增(post) 修改(put) 删除(delete) 获取(get)

uri：以/a开头，get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。

请求参数：分为5列：字段、说明、类型、备注、是否必填字段是类的属性；说明是中文释义；类型是属性类型，只有String、Number、Object、Array四种类型

返回参数，结构有几种情况：1、如果只返回接口调用成功还是失败（如新增、删除、修改等），则只有一个结构体：code和message两个参数；2、如果要返回某些参数，则有两个结构体：1是code/mesage/data，2是data里写返回的参数,data是object类型；3、如果要返回列表，那么有三个结构体。

3.接口测试用例模板介绍

核心要素：用例编号 ,用例标题，模块，优先级，前提条件，请求类型，请求参数，操作步骤，预期结果