欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  后端开发

PHP开发APP接口注意事项

程序员文章站 2022-05-05 19:16:44
...
一、双方统一接口开发文档

为了提升开发效率及沟通方便,需要建立规范的开发文档。
一般保护接口的功能或页面、接口地址、接口参数、接口返回值等说明。
参考文档格式:
PHP开发APP接口注意事项

二、注意以下

  1. 分版本,为后面接口升级做好打算。
  2. 提供密钥和token。确保数据不被篡改。
  3. 读数据用get,修改数据用post。
  4. 接口返回值格式统一结构。 用JSON格式输出
  5. 接口记录日志。记录请求参数、占用内存、响应时间、响应时长。方便后续优化。
  6. 提供统一的错误码。每个数字代表一种错误,需要在文档中说明。错误分系统错误和业务逻辑错误。 建立接口文档。
  7. 记录每个接口的用途,参数列表,返回值说明。同时给出使用例子。
').addClass('pre-numbering').hide(); $(this).addClass('has-numbering').parent().append($numbering); for (i = 1; i ').text(i)); }; $numbering.fadeIn(1700); }); });

以上就介绍了 PHP开发APP接口注意事项,包括了方面的内容,希望对PHP教程有兴趣的朋友有所帮助。