首页  >  文章  >  后端开发  >  PHP开发APP接口需要注意哪些问题

PHP开发APP接口需要注意哪些问题

小云云
小云云原创
2018-03-05 13:24:102922浏览


一、双方统一接口开发文档为了提升开发效率及沟通方便,需要建立规范的开发文档。 一般保护接口的功能或页面、接口地址、接口参数、接口返回值等说明。 

参考文档格式:
这里写图片描述

二、注意以下

  1. 分版本,为后面接口升级做好打算。

  2. 提供密钥和token。确保数据不被篡改。

  3. 读数据用get,修改数据用post。

  4. 接口返回值格式统一结构。 用JSON格式输出

  5. 接口记录日志。记录请求参数、占用内存、响应时间、响应时长。方便后续优化。

  6. 提供统一的错误码。每个数字代表一种错误,需要在文档中说明。错误分系统错误和业务逻辑错误。 建立接口文档。

  7. 记录每个接口的用途,参数列表,返回值说明。同时给出使用例子。

一、双方统一接口开发文档

为了提升开发效率及沟通方便,需要建立规范的开发文档。
一般保护接口的功能或页面、接口地址、接口参数、接口返回值等说明。
参考文档格式:
这里写图片描述

二、注意以下

  1. 分版本,为后面接口升级做好打算。

  2. 提供密钥和token。确保数据不被篡改。

  3. 读数据用get,修改数据用post。

  4. 接口返回值格式统一结构。 用JSON格式输出

  5. 接口记录日志。记录请求参数、占用内存、响应时间、响应时长。方便后续优化。

  6. 提供统一的错误码。每个数字代表一种错误,需要在文档中说明。错误分系统错误和业务逻辑错误。 建立接口文档。

  7. 记录每个接口的用途,参数列表,返回值说明。同时给出使用例子。

相关推荐:

详解app接口之token

laravel编写APP接口(API)

PHP开发APP接口视频教程

以上是PHP开发APP接口需要注意哪些问题的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn