PHP开发APP接口实现–基本篇

PHP开发APP接口实现–基本篇

最近一段时间一直在做APP接口,总结一下APP接口开发以来的心得,与大家分享:

1. 客户端/服务器接口请求流程:

安卓/IOS客户端   –> PHP接口 –> 服务器端  –> 数据处理 –> 返回值(客户端接收并处理)

APP的通信方式:

    客户端   (接口地址:http://app.com/api.php?format=xml/json)
    客户端APP   ——————————>  服务器
               <—————————–   
                            返回数据

2.客户端APP通信格式区别

1.XML:扩展标记语言 ,(用于标记电子文件使其具有结构性的标记语言,可以用来标记数据、定义数据类型,是一种允许用户对自己的标记语言进行定义的源语言)

2.JSON:一种轻量级的数据交换格式,具有良好的可读和便于快速编写的特性。可在不同平台之间进行数据交换。JSON采用兼容性很高的、完全独立于语言文本格式,同时也具备类似于C语言的习惯(包括C, C++, C#, Java, JavaScript, Perl, Python等)体系的行为。

JSON格式如下:

XML的可读性要好,JSON的生成数据性 (json_encode(数组)) 传输速度方面要好

3.客户端请求方式/传值类型

3.1 GET请求:Get请求参数通过URL地址传递,在URL中传送的参数是有长度限制的,传值大小为2KB,而且相对于POST方式不是很安全。

3.2 POST请求:POST请求参数通过request body传递参数,数据传输安全性较高,而且支持多种数据格式的传输,如,数组、字符串等等。

POST的请求如下:

最直观的区别就是GET把参数包含在URL中,POST通过request body传递参数。

3.文档规范

接口文档主要包括:文档名称、接口名称、请求地址、请求方式、请求参数、返回值、参数注释以及状态码。

3.1 请求示例:

3.2 返回示例:

3.3 参数注释:

3.4 返回结果

常用的有在线文档和doc文档两种,个人推荐在线文档,https://apizza.net

在团队协作开发中,文档规范能更快的提高团队工作效率,降低沟通成本,加之APP版本迭代,方便快速查阅文档。

4.接口调试

客户端在请求接口时,根据文档接口传递相关参数,类似于我们做表单提交时,传递的参数一样。客户端请求接口时,一般流程如下:

接口地址:http://api.nanniwan.com/user/ls.api
接口参数:

① 必要性的token验证(即用户登录验证)

② 必传参数:接口接收数据并做处理(具体根据业务需求定义)

③ 请求 响应  返回值

可以通过Postman来模拟调试接口,具体如下:

至此,APP接口基础篇就讲解完毕,具体实践,请看一下节。
———————
作者:No.1117
来源:CSDN
原文:https://blog.csdn.net/qq_29920751/article/details/83271818
版权声明:本文为博主原创文章,转载请附上博文链接!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/112472.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • C# TextBox输入密码显示星号(*)

    C# TextBox输入密码显示星号(*)在textBox上右键属性在行为-passwordChar后输入*

    2022年7月24日
    38
  • StringUtils函数全集「建议收藏」

    StringUtils函数全集「建议收藏」StringUtils中方法的操作对象是java.lang.String类型的对象,是JDK提供的String类型操作方法的补充,并且是null安全的(即如果输入参数String为null则不会抛出NullPointerException,而是做了相应处理,例如,如果输入为null则返回也是null等,具体可以查看源代码)。除了构造器,StringUtils中一共有130多个方法…

    2022年6月1日
    27
  • js数组删除指定数据方法「建议收藏」

    js数组删除指定数据方法「建议收藏」js数组中删除指定数据1,splice删除(配合indexOf()方法)2,filter删除3,Set删除

    2022年10月1日
    2
  • linux安装ssh和开启 ssh服务

    1.查看ssh服务的状态输入以下命令:sudoservicesshdstatus如果出现Loaded:error(Reason:Nosuchfileordirectory)提示的话,说名没有安装ssh服务,按照第二步:安装ssh服务。如果出现Active:inactive(dead)说明已经安装了ssh服务,但

    2022年4月14日
    49
  • 人工势场法matlab讲解_【机器人路径规划】人工势场法

    人工势场法matlab讲解_【机器人路径规划】人工势场法阅读本文需要的基础知识为:理解机器人的构型空间。建议阅读:机器人运动规划中的Cspace怎样理解?为什么不直接在笛卡尔坐标系下运算呢?本文的实现程序与使用说明见我的学习工具箱:小明工坊:【个人开源】机器人运动规划学习工具箱使用说明基本原理1.概述我们打两个比方来说明人工势场法的作用机理。首先,我们把构型空间比作一个电势场平面,机器人(的当前构型)比作空间中一点。如果让机器人的起点和障碍物带正…

    2022年6月16日
    27
  • eclipse代码自动补全设置_eclipse怎么运行安卓项目

    eclipse代码自动补全设置_eclipse怎么运行安卓项目打开Eclipse->Window->Perferences->Java->Editor->Content,最下面一栏auto-Activation会看到只有一个”.”存在。表示:只有输入”.”之后才会有代码提示,我们要修改的地方就是这里,可是Eclipse默认只允许输入4个自定义字符。先把上图中”.”的地方输入几个随便的字符,例如”aaaa…

    2022年10月15日
    2

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号