接⼝测试之接⼝api⽂档的重要性
接⼝⽂档的特点
接⼝⽂档，顾名思义就是对接⼝说明的⽂档。好的接⼝⽂档包含了对接⼝URL，参数以及输出内容的说明，我们参照接⼝⽂档就能编写出⼀个个的测试⽤例。⽽且接⼝⽂档详细的话，测试⽤例编写简单，不会遗漏。
如果⼀个接⼝⽂档没有写清楚，你从⽂档中分不出哪些⼉参数是必需的，哪些⼉是⾮必须的，⽽且没有参数的取值说明，返回值的结构等信息的话，测试⼈员是⽆法编写相应的测试⽤例的。但是由于开发⼈员不愿意写⽂档，所以很多接⼝⽂档相对来说⽐较简单，模糊不清，这对我们做接⼝⾃动化测试是很⼤的阻碍。
7.2 接⼝⽂档的结构
接⼝⽂档可以包含很多信息，有的愿意写就可以多写的，不太愿意写的话，就写的信息相对来说会少点⼉。不过，下⾯⼏项内容必须有，这是我们使⽤接⼝中和测试接⼝的依据：
（1）接⼝名称。标识各个接⼝的简单说明，如登录接⼝，获取项⽬详情接⼝等。
（2）接⼝URL。接⼝的调⽤地址，在测试环境下前⾯的域名可能不⼀样，不过接⼝名是不会变的。
（3）调⽤⽅式。接⼝的调⽤⽅式：Post/Get⽅式，决定了如何调⽤接⼝及传递参数。
（4）参数。接⼝需要传递的参数，参数需要增加些⼉说明：
（a）参数值类型说明：参数值要说明⼀下，只⽀持字母，数据，特殊字符或是字母数据混搭。
（b）参数长度说明：参数接收最⼤多少个的字符串，或是最⼤是多少的数值等。
（c）参数取值范围：像枚举型的参数，只接收什么范围内的数据，如1-5等。
（d）参数的配合说明：有些⼉参数需要配合起作⽤的，如：offset和count参数。
（e）参数是必需的还是⾮必需的。
（5）返回值。接⼝的返回值说明需要包含正确和错误的情况，正确的情况下有哪⼉数据，错误的情况下会有什么提⽰？
（6）其他的⼀些⼉说明。上⾯的说明是通⽤的，还有其他的⼀些⼉说明，如必须是登录状态调⽤，或是版本号等说明，在某些⼉情况下也需要说明⼀下。
严格要求的公司会要求接⼝开发⼈员标明上⾯相关的接⼝说明，此时我们做接⼝测试的时候，就可以参
照⽂档来转化我们的测试⽤例。但⽬前国内很多公司不太注重⽂档，接⼝信息不全是常有的事情。
7.3 接⼝⽂档缺失
针对⽬前接⼝⽂档信息不全或是没有接⼝⽂档的情况下，如果上⾯的领导要求我们做接⼝⾃动化测试，这⽆异是⼀个⾮常艰⾟的任务。但是奉承着“兵来将当，⽔来⼟掩”的原则，我们要想着解决办法。
（1）完全没有接⼝⽂档。这个情况是最⿇烦的，我们要开发⼈员来商量，最好能补个接⼝⽂档，如果实在来不及那就给个调⽤接⼝的实例。实例中会有接⼝地址，参数等信息，我们去测试环境中调⽤⼀下，就能看到返回结果的情况。
（2）接⼝⽂档信息不全。信息不全这个最常见，像参数说明缺少啊，没有说明哪些⼉是必需的参数，哪些⼉是⾮必需的，或是没有说明取值范围等。此时我们能问开发就问开发，如果不太⽅便，就要做尝试：⼀般⾮必需的参数不会做容错的判断，必需的参数检测的⽅⾯⽐较全⾯。接口文档怎么看
（3）⽂档不是最新的。接⼝的后续的⼯作中被修改或是优化过，我们按接⼝⽂档上的说明去调⽤，返回和预期的不⼀样。通知开发更新⽂档，然后⽤最新的⽂档再去修改测试⽤例。
这个接⼝⽂档需要和接⼝开发⼈员做好约定，开发新接⼝时要把接⼝信息写清楚，如果更新原来的接⼝，要及时更新接⼝⽂档。同时在写接⼝⾃动化测试⽤例的时候，要多和开发⼈员沟通，只有通过⼤家
的⼀起努⼒，才能把⼯作做的越来越好。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。