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

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

二、注意以下

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

PHP开发APP接口注意事项相关推荐

  1. appcontroller.php,php用什么开发app接口

    可以使用 REST模式 来开发 App 接口,首先建立一个公共控制器,再建其他控制器继承它即可. 确定好返回的数据内容格式及信息码: (推荐学习:PHP视频教程)<?php // App接口公共 ...

  2. PHP开发APP接口(二)

    这里将会调用前面博客的数据库连接单例.文件缓存类和开发APP接口(一) [php] view plain copy  print? <?php // http://app.com/list.ph ...

  3. php开发APP接口 接收客户端的图片

    php开发APP接口 接收客户端的图片 header( "Content-Type: image/jpeg" ); $filename = time(). '.png' ; $st ...

  4. php app接口开发,「PHP开发APP接口实战005」基础示例接口的实现一

    前一章,我们对接口参数基本定义做了一个简要说明.里面提到了几个示例接口,接下来,我们就来讲解这个几点个示例接口的具体实现. 「PHP开发APP接口实战004」基础响应参数说明 前言 由于我们的接口返回 ...

  5. php app接口id参数类型过滤,PHP开发APP接口---返回数据的封装类

    /** * app返回数据类 * 1.接受多维,缺少键名的数组, * 2.可由输入的format参数决定返回数据格式 * 例子:Response::show(200, 'success', $data ...

  6. PHP开发APP接口全过程(一)

    1.学习要点: 服务器端 –> 数据库|缓存 –>调用接口 –>客户端 2.APP接口介绍:(PHP开发APP接口) PHP面向对象的接口:抽象类,interface定义 ==> ...

  7. php开发APP接口(一)

    php开发APP接口(一) 使用PHP来生成APP接口数据是非常简单的,如果你还不了解PHP没有关系,只需要看过PHP的基本语法,再看本示例就可以了. APP接口一般都是json格式(当然也有少数xm ...

  8. 使用PHP开发App接口的一些体会

    前言 做了1年半的PHP开发,对PHP写接口的一些注意事项和心得体会也是有一些的.有空就写下来分享一下,大部分参考别人的一些建议. 文档要写周全,需要的每个字段,规定是什么类型,什么含义要标柱清楚,写 ...

  9. php接口调用实例源代码,小蚂蚁学习APP接口开发(7)—— APP接口实例——读取缓存方式开发APP接口的代码案例...

    从数据库中直接读取数据,虽然时效性很强,但是对数据库造成很大压力,尤其是在高访问量的情况下.这时候可以通过缓存,来有效的缓解了这一压力,虽然时效性有些不足,但是服务器的抗压能力却达到了很大的提高. 读 ...

最新文章

  1. linux虚拟网络设备-- TUN/TAP MACVLAN MACVTAP(八)
  2. 与善淘网一起做慈善商店
  3. c++11中static类对象构造函数线程安全
  4. Spring Boot(十七):使用Spring Boot上传文件
  5. vue 3D旋转木马轮播图
  6. c 插件读取有属性的html6,廖雪峰的JS教程6-jQuery
  7. leetcode3. Longest Substring Without Repeating Characters
  8. 1.Java 面试题整理(基础篇一)
  9. sed: sed command a expects followed by text
  10. 双时隙的工作原理_提高频点利用 海能达双时隙功能效率高
  11. VS2008个人博客系统
  12. 梯度散度旋度常用基本关系
  13. java类为什么要序列化_Java 中的类为什么要实现序列化呢
  14. 51单片机——ADC模数转换、DAC数模转换PWM C语言入门编程
  15. Power Apps从入门到放弃教程
  16. sql半小时,小时,天,月,年分组,日期函数day() 、month()、year()
  17. shell批量替换文本中的多种字符串
  18. POJ2228 Naptime 【例题精讲】
  19. Android拖动进度条画面随动,Android学习笔记(24):进度条组件ProgressBar及其子类
  20. 当当API接口-item_get - 获得dangdang商品详情

热门文章

  1. 含论文+答辩PPT+任务书+中期检查表+源码等javaweb网络考试系统
  2. Ajax-Zoom 快速上手
  3. Android App开发超实用实例 | ​Broadcast
  4. display有哪些值?说明他们的作用?
  5. hadoop读写mysql数据库
  6. GPS L5软件接收机的编写
  7. MSVCP120.DLL错误
  8. easybuy源码_EasyBuy 易买网购物系统,前台和后台界面,流畅清晰 Java Develop 238万源代码下载- www.pudn.com...
  9. 忘了BIOS密码不用慌 多种方法可解决
  10. 【Matlab】PSOt工具箱使用