1. 原由
由于在接口开发中没有进行相关接口的文档设计，导致返工严重，质量很差。所以在此进行一些相关总结，也请大家指正。如：开发消息推送接口时没有充分调研消息推送AP，I没有对消息格式进行规定，消息顺序进行设置，消息传输协议进行调研，没有对request进行校验，导致临发布紧急修改，同时测试时只测试了接口是否调用正常，没有查看相关功能是否返回数据正常造成线上bug。
2. 需求分析
可以从以下几个方面进行分析：
1. 该接口应用场景；
2. 需求可行性调研；
结合应用场景分析，如正推分析是否可行，反推是否可行。
3.是否会对其他接口造成影响，是否兼容；
3. 接口设计
1. request ；2. response；3. 相关表设计；
阐述一下，request是否加必要校验（前端，后端），是否可以提取公共参数；2，response是否返回有中文（正常情况下返回的是英文，或枚举类型），是否可以提取公共参数；3. 表设计是否配置了必要的索引，包括联合索引，字段大小是否涉及合理，如设计过大，造成存储空间的浪费。
4. 开发
注意事项：request或者response是否存在超过设计字段长度的情况发生；涉及到的方法是否可以进行抽象，提取为相关接口；是否给常量赋予意义。多线程情况下是否加锁是否是多线程进行的调用；时间复杂度和空间复杂度分别是多少是否可以通过代码优化来降低。
5. 测试用例
1. UT测试 --验证代码逻辑的是否正常。
2. BVT测试-- 验证接口调用是否正常。
测试用例关注点：接口是否达到设计预期，是否满足需求，是否有优化空间， 接口改造是否兼容原来接口，是否对其他相关接口造成影响。
网友评论