摘要:开发者在调用API过程中往往需要借助一些工具以便创建更加优质的应用,本文我们将分享构建API监视器的五大实践技巧,以飨读者。
1. 重用开发中的功能测试
重用API测试功能在开发及测试监视过程中有几大优势:
- 不只是检查可用性,API “真正的”功能是能够被连续不断的审查,在持续部署实践和更改基础设施时为你提供一个安全的网络环境。
- 鉴于API功能测试需要设置维护并提供相关的错误信息,相比常规的可用性监视器,API监视器将为你提供更加详细的错误信息原因分析。
- 鉴于你的API功能显示器模拟预期的使用场景,其实际架构可告之安全操作小组(Operation Security Team)如何使用API并帮助创建相应的API基础设施。
- 很显然,利用一款工具来创建测试和监视在维护、学习、成本等方面开销是比较低的。
2. 创建模拟用例测试
如果你要集成第三方API(例如 Twitter, Google Maps等),首先,需要确保在提交给用户之前了解失败的原因,这一点至关重要;然后在创建监视模拟如何使用你的API。比如,如果你正在使用Flickr API为某个团队获取最新的图片,请确保你的API监视器在做同样的事情,而不是获取一组流行的图片(或者其他易于设置的东西)。同时,确保能够监控整个用列流程,不是只监控第一个API请求,而是监控所有序列事件——就如同你的应用程序在使用它们。
3. 准备更改数据
监控第三方API是个较为棘手的问题。通常你的监视器想要验证输入结果,比如,你想利用Google Maps APIs来验证每次预计来回的坐标或路线。然而,谷歌更新坐标频率相当频繁,因此,如果你的监视器无需考虑“波动性”,那么就不存在失败。这一点同样适用于路径规划,在一定的时间内也许会因一个交通堵塞让谷歌返回不同的“意外”结果——这便是你需要准备的。
换句话说,如果你不打算利用API监视器验证返回数据,那么你打算验证什么来确保其工作需求呢?也许这个很难回答,我建议你至少要使用防御性数据验证;无需太多,试图专注于那些你认为永远不会改变的即可。
4. 使用专用账户
许多(大多数)API需要你指定某种凭证或者访问关键字,以确在保监视器上显示你正在使用专用账户,无论是你自己的API还是第三方API都如此。究其原因:
- 对于你自己的API,运行监视器你和你的用户具有相同的访问权限,因此当你发现问题时不会影响到“超级用户”账户。
- 对于第三方API,它允许收费并利用宽带从你“开发”的API使用率中分离出来。
5. 不要过量使用
很多开发者希望尽可能多的使用产品(免费版、商业版),我劝你不要过分使用API监视器。因为你并不需要监控全球的每个地理位置或者监控API每一次的操作输入。相反,你应该确保API监视器时刻处于安全的网络来捕捉API“热点(hot-spots)”问题并且能够覆盖最重要的API业务领域。
倘若过量使用将会导致API监视器维护不善,导致启动失败。一开始你会忽视,最终将导致其不会向任何人提供任何价值信息。