PHP 接口开发注意事项
PHP 接口开发注意事项
预先定义接口流程和逻辑,确认需求
在开发前首先确定流程,复杂的接口可以绘制流程图,并确保流程与需求一致;
使用统一的变量定义
无论是SDK还是Server均因同一变量的定义以及全局变量的设置。目的是方便维护
完善的异常处理机制
接口是向外提供服务的,一旦出现异常影响较大,甚至影响系统的安全。因此需要一套完善的异常处理机制。如常见的网络连接超时等,对file_get_contents和fsocket之类的函数,需要使用@抑制错误输出
统一的提示信息输出格式
统一格式的输出会很大程度上的方便使用者
SDK的兼容性
充分考虑SDK的兼容性问题,不是所有的使用者的环境都是5.3,不是所有的环境都支持curl。最坏的考虑是提示用户安装curl扩展。PHP版本的限制至少能在5.0以上,不要使用自己不熟悉的函数,尤其是对PHP版本有依赖的
友好的错误提示
无论服务是否正常,都应该向用户数据优化的错误提示
安全机制
对用户输入数据严格过滤,避免服务存在的安全隐患
服务高可用
很多业务依赖服务接口,因此接口的高可用必不可少,应该建立监控接口,在服务所依赖的接口出现故障时及时发现和排除。
预先定义接口流程和逻辑,确认需求
在开发前首先确定流程,复杂的接口可以绘制流程图,并确保流程与需求一致;
使用统一的变量定义
无论是SDK还是Server均因同一变量的定义以及全局变量的设置。目的是方便维护
完善的异常处理机制
接口是向外提供服务的,一旦出现异常影响较大,甚至影响系统的安全。因此需要一套完善的异常处理机制。如常见的网络连接超时等,对file_get_contents和fsocket之类的函数,需要使用@抑制错误输出
统一的提示信息输出格式
统一格式的输出会很大程度上的方便使用者
SDK的兼容性
充分考虑SDK的兼容性问题,不是所有的使用者的环境都是5.3,不是所有的环境都支持curl。最坏的考虑是提示用户安装curl扩展。PHP版本的限制至少能在5.0以上,不要使用自己不熟悉的函数,尤其是对PHP版本有依赖的
友好的错误提示
无论服务是否正常,都应该向用户数据优化的错误提示
安全机制
对用户输入数据严格过滤,避免服务存在的安全隐患
服务高可用
很多业务依赖服务接口,因此接口的高可用必不可少,应该建立监控接口,在服务所依赖的接口出现故障时及时发现和排除。
郑重声明:本站内容如果来自互联网及其他传播媒体,其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享,并不代表本站赞同其观点和对其真实性负责,也不构成任何其他建议。