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接口基础篇就讲解完毕，具体实践，请看一下节。

原文：https://blog.csdn.net/qq_29920751/article/details/83271818

 

【PHPer技术栈】专注后端开发，倡导开源文化，做一个有趣、有灵魂的PHPer工程师，欢迎大家关注！