开发php接口注意点

Posted 2020-09-05 shenzen_小白

1.制定规范
　　开发前一定要定好一个规范，比如要定好数据返回的通用参数和格式。关于数据格式，用的比较多的有xml和json，我建议用json，因为json比xml的好处更多。

　　2.精简的返回数据
　　接口数据因符合需要什么返回什么的原则，比如要查询某个用户的余额和注册时间，网页里面的做法可能是select * from user where uid=1，但是接口一定要select balance,regtime from user where uid=1。因为接口返回数据是要有开销的，要流量的，能少返回数据就尽量少返回，这样可以大大的提高性能。

　　3.数据类型要严格
　　要注意数据的类型，整数类型的数据一定要转为int，因为app客户端开发的java、object-c语言对数据类型比较严格，类型不对会照成app闪退。

　　4.要写接口文档
　　一定要写好接口文档，并按照模块写，而且还要书写规范，最好的格式是：
　　接口请求地址；请求参数（包括参数名、类型、是否必填）；测试参数举例；返回参数（参数名，并注明每个参数的含义）。
　　这样哪怕以后项目很大，以不会照成维护困难的问题。

　　5.保证代码正确性
　　要验证保证代码正确无误，而且生成环境中要屏蔽掉错误，避免头部有额外的输出，照成返回的json等数据解析失败而导致app闪退等。

　　6.要优化代码的性能
　　app要求响应迅速，这样才能给用户比较好的体验感。所以移动接口端在处理业务逻辑的时候，要避免不要执行太复杂的sql语句，或者含有大量的循环，能做成缓存的尽量做缓存，比如将首页的热点模块信息可以存到redis缓存中。在不考虑网速的情况下，比较理想的接口响应时间应该是200毫秒以内。

　　7.不要随意更改旧接口
　　app不像网页，app一旦发布，有人使用之后，接口就不要乱修改了。以后升级也是，修改要在保证接口原有结构之上进行额外的扩展，否则会导致调用旧版接口的app出现bug。

　　8. 注意接口的安全
　　安全高于一切，必须要保证接口的安全。电话号码等敏感信息在传输的过程中一定要加密，否则可能会被别人抓包到。拿取用户信息的接口一定要验证权限，以防止接口被恶意调用，泄密用户信息，甚至篡改信息。