api 接口开发理论 在php中调用接口以及编写接口

如:
http://localhost/openUser.php?act=get_user_list&type=json

在这里openUser.php相当于一个接口,其中get_user_list 是一个API(获取用户列表),讲求返回的数据类型为JSON格式。

你只需要在你PHP代码中执行这条链接他就会返回。
GET方式的直接使用
$file_contents = file_get_content('http://localhost/openUser.php?act=get_user_list&type=json')

POST方式得用下面的(需要开启PHP curl支持)。
$url = 'http://localhost/openUser.php?act=get_user_list&type=json';
$ch = curl_init ();
curl_setopt ( $ch, CURLOPT_URL, $url );
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt ( $ch, CURLOPT_CONNECTTIMEOUT, 10 );
curl_setopt ( $ch, CURLOPT_POST, 1 ); //启用POST提交
$file_contents = curl_exec ( $ch );

curl_close ( $ch );



 在PHP 中编写接口


一、先简单回答两个问题:

1、PHP 可以开发客户端?
答:不可以,因为PHP是脚本语言,是负责完成 B/S架构 或 C/S架构 的S部分,即:服务端的开发。(别去纠结 GTK、WinBinder)

2、为什么选择 PHP 作为开发服务端的首选?
答:跨平台(可以运行在UNIX、Linux、WINDOWS、Mac OS下)、低消耗(PHP消耗相当少的系统资源)、运行效率高(相对而言)、MySQL的完美搭档,本身是免费开源的,......

二、如何使用 PHP 开发 API(Application Programming Interface,应用程序编程接口) 呢?

做过 API 的人应该了解,其实开发 API 比开发 WEB 更简洁,但可能逻辑更复杂,因为 API 其实就是数据输出,不用呈现页面,所以也就不存在 MVC(API 只有 M 和 C),
1、和 WEB 开发一样,首先需要一些相关的参数,这些参数,都会由客户端传过来,也许是 GET 也许是 POST,这个需要开发团队相互之间约定好,或者制定统一规范。
2、有了参数,根据应用需求,完成数据处理,例如:任务进度更新、APP内购、一局游戏结束数据提交等等
3、数据逻辑处理完之后,返回客户端所需要用到的相关数据,例如:任务状态、内购结果、玩家信息等等
数据怎么返给客户端?
直接输出的形式,如:JSON、XML、TEXT 等等。
4、客户端获取到你返回的数据后,在客户端本地和用户进行交互

临时写的一个简单 API 例子:

  1. <?php
  2. $output = array();
  3. $a = @$_GET['a'] ? $_GET['a'] : '';
  4. $uid = @$_GET['uid'] ? $_GET['uid'] : 0;

  5. if (empty($a)) {
  6.     $output = array('data'=>NULL, 'info'=>'坑爹啊!', 'code'=>-201);
  7.     exit(json_encode($output));
  8. }

  9. //走接口
  10. if ($a == 'get_users') {
  11.     //检查用户
  12.     if ($uid == 0) {
  13.         $output = array('data'=>NULL, 'info'=>'The uid is null!', 'code'=>-401);
  14.         exit(json_encode($output));
  15.     }

  16.     //假设 $mysql 是数据库
  17.     $mysql = array(
  18.         10001 => array(
  19.             'uid'=>10001,
  20.             'vip'=>5,
  21.             'nickname' => 'Shine X',
  22.             'email'=>'979137@qq.com',
  23.             'qq'=>979137,
  24.             'gold'=>1500,
  25.             'powerplay'=> array('2xp'=>12,'gem'=>12,'bingo'=>5,'keys'=>5,'chest'=>8),
  26.             'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17),
  27.             'ctime'=>1376523234,
  28.             'lastLogin'=>1377123144,
  29.             'level'=>19,
  30.             'exp'=>16758,
  31.         ),
  32.         10002 => array(
  33.             'uid'=>10002,
  34.             'vip'=>50,
  35.             'nickname' => 'elva',
  36.             'email'=>'elva@ezhi.net',
  37.             'qq'=>NULL,
  38.             'gold'=>14320,
  39.             'powerplay'=> array('2xp'=>1,'gem'=>120,'bingo'=>51,'keys'=>5,'chest'=>8),
  40.             'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17),
  41.             'ctime'=>1376523234,
  42.             'lastLogin'=>1377123144,
  43.             'level'=>112,
  44.             'exp'=>167588,
  45.         ),
  46.         10003 => array(
  47.             'uid' => 10003,
  48.             'vip' => 5,
  49.             'nickname' => 'Lily',
  50.             'email' => 'Lily@ezhi.net',
  51.             'qq' => NULL,
  52.             'gold' => 1541,
  53.             'powerplay'=> array('2xp'=>2,'gem'=>112,'bingo'=>4,'keys'=>7,'chest'=>8),
  54.             'gems' => array('red'=>13,'green'=>3,'blue'=>9,'yellow'=>7),
  55.             'ctime' => 1376523234,
  56.             'lastLogin'=> 1377123144,
  57.             'level' => 10,
  58.             'exp' => 1758,
  59.         ),
  60.     );
  61.     
  62.     $uidArr = array(10001,10002,10003);
  63.     if (in_array($uid, $uidArr, true)) {
  64.         $output = array('data' => NULL, 'info'=>'The user does not exist!', 'code' => -402);
  65.         exit(json_encode($output));
  66.     }

  67.     //查询数据库
  68.     $userInfo = $mysql[$uid];
  69.     
  70.     //输出数据
  71.     $output = array(
  72.         'data' => array(
  73.             'userInfo' => $userInfo,
  74.             'isLogin' => true,//是否首次登陆
  75.             'unread' => 4,//未读消息数量
  76.             'untask' => 3,//未完成任务
  77.         ), 
  78.         'info' => 'Here is the message which, commonly used in popup window', //消息提示,客户端常会用此作为给弹窗信息。
  79.         'code' => 200, //成功与失败的代码,一般都是正数或者负数
  80.     );
  81.     exit(json_encode($output));
  82. } elseif ($a == 'get_games_result') {
  83.     //...
  84.     die('您正在调 get_games_result 接口!');
  85. } elseif ($a == 'upload_avatars') {
  86.     //....
  87.     die('您正在调 upload_avatars 接口!');
  88. }
复制代码

点击测试(对于客户端而言,也是直接调用这样的地址):
http://www.ezhi.net/api/test/index.php
http://www.ezhi.net/api/test/index.php?a=get_users
http://www.ezhi.net/api/test/index.php?a=get_users&uid=10001
http://www.ezhi.net/api/test/index.php?a=get_users&uid=10002
http://www.ezhi.net/api/test/index.php?a=get_users&uid=10003

三、实际项目中,我们在开发 API 应该注意的几个事项(仅供参考):
1、单文件实现多接口的形式有很多种,例如:if..elseif.. 或 switch 或 动态方法 (也就是TP的这种访问函数体的形式)
2、对于数据的输出最好用json,json具有相当强大的跨平台性,市场上各大主流编程语言都支持json解析,json正在逐步取代xml,成为网络数据的通用格式
3、接口安全,一定要增加接口验证。例如,客户端和服务端针对不同接口统一做好加密方式,服务端在对于每次接口需要都要进行验证。以保证防止接口被恶意刷新或黑客恶意调用,尤其是大型商业应用。
4、对于线上的 API 必须保证所有接口正常且关闭所有的错误信息 => error_reporting(0),在输出JSON 时,不能有任何其它输出,否则,客户端将解析数据失败,直接 Crash!
5、开发 API 和 WEB 有一定的区别,如果是 WEB 的话,可能代码出错了,不会导致特别严重的错误,也许只是导致数据写入和查询失败,也许导致 WEB 的某个部分错位或乱码。但如果是 API,直接 Crash!
6、做接口开发,不建议使用框架开发,原因概括起来有两点(其实我有点冒风险的,本人也是 TPer 一枚,毕竟这是TP的官网):
  1)客户端一般对服务端的响应速度有极高要求,因此,使用最原生态的 PHP 完成接口开发,是最高效的,假如用到了框架,还需要加载各种不需要多余的文件,就好比夏天穿了件冬天的衣服。试想,你在玩手机的时候,使用一个应用随便一个操作,等半天才有动静,你受的了吗?

  2)就是上面第4点提到的,框架对于WEB开发,是件很幸福的事,但对于 API 而言,你实在不敢想象它会给你出什么岔子!最后你将痛苦不堪~~因为很多框架都是为 WEB 诞生的(我也很期待有一天能看到专门为开发 API 而生的框架或者扩展)

  这个也有人纠结,接口效率与稳定性,还得看编码的人,有的人可能写的还不如框架跑的快,也有人觉得用框架没什么问题,这里只是建议,关键看自己的实际情况,同时建议代码上线前压测一下

  说到这,不得不说扯一下,腾讯微博淘宝等开放平台。其实那些开放平台,所谓的开放,就是给你提供一个这样的接口,你根据他们提供的技术文档,按他们制定的格式和要求,调它们提供的接口文件(一般都是返回JSON或者XML),你就可以获取到他们的相关信息,例如:QQ用户基本信息、淘宝店铺、商品消息等等。然后在根据这些消息,在你的应用里完成交互。

  其实,ajax 也是调用 API 的接口

转载于:https://www.cnblogs.com/hnbiao/p/6545104.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/284314.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

怎么样的框架对于开发者是友好的?

云原生离.NET开发到底有多远&#xff1f;云原生的概念由来不久&#xff0c;故事从“上云”开始&#xff0c;伴随dorker、k8s等技术的推出&#xff0c;以及CNCF与各大云厂商的共同加持&#xff0c;云原生逐渐被大家所熟知。云原生不依赖具体的云&#xff0c;不管公有云还是私有云…

JS 烧脑面试题大赏

本文精选了20多道具有一定迷惑性的js题&#xff0c;主要考察的是类型判断、作用域、this指向、原型、事件循环等知识点&#xff0c;每道题都配有详细傻瓜式的解析&#xff0c;偏向于初学者&#xff0c;大佬请随意。 第1题 let a 1 function b(a) {a 2console.log(a) } b(a)…

苹果ios用js的Date()出现NaN问题解决办法

原文:苹果ios用js的Date&#xff08;&#xff09;出现NaN问题解决办法ios使用如下方法获得NaN&#xff0c;安卓手机则是正常计算&#xff0c;解决方法是换个这个时间的格式 new Date("2017-04-28 23:59:59").getTime() 换成如下方式就正常了&#xff0c;就是‘-’换成…

Thinkphp 验证码、文件上传

一、验证码 验证码参数 例题&#xff1a;登录时验证下验证码 LoginController.class.php <?php namespace Home\Controller; use Think\Controller; class LoginController extends Controller {public function Login(){if(empty($_POST)){$this->display(); } e…

ArcGIS实验教程——实验四十七:数据驱动页工具批量制作甘肃省各地级市人口七普专题图集

本实验详细讲解利用ArcGIS数据驱动页工具,制作甘肃省各地级市人口七普专题图集。 文章目录 1. 数据驱动页工具简介2. 甘肃省各地级市人口七普专题图集2.1 符号化及标注2.2 数据驱动页的创建2.3 数据驱动页面文本操作2.4 数据驱动页的导出1. 数据驱动页工具简介 数据驱动页面是…

为什么Java有GC调优而没听说过有CLR的GC调优?

前言在很多的场合我都遇到过一些群友提这样的一些问题&#xff1a;为什么Java有GC调优而CLR没有听说过有GC调优呢&#xff1f;到底是Java的JVM GC比较强还是C#使用的.NET CLR的GC比较强呢&#xff1f;其实业内已经有几位大佬的高赞文章和大家分享一下&#xff0c;主要讨论JVM和…

Ubuntu16.04 - 安装RabbitVCS,linux下的TortoiseSVN!!!

RabbitVCS 官网&#xff1a;http://rabbitvcs.org/ 1&#xff0c;添加PPA源。在shell里面执行下面命令&#xff1a; sudo add-apt-repository ppa:rabbitvcs/ppa 这个命令执行完毕后&#xff0c;查看执行结果看是否密钥导入成功&#xff0c;成功截图&#xff1a; 如果导入密钥失…

8 种最坑的SQL错误用法

1、LIMIT 语句 2、隐式转换 3、关联更新、删除 4、混合排序 5、EXISTS语句 6、条件下推 7、提前缩小范围 8、中间结果集下推 总结 sql语句的执行顺序&#xff1a; FROM <left_table>ON <join_condition><join_type>JOIN <right_table>WHERE &…

Vue根据菜单json数据动态按需加载路由Vue-router

每个菜单项对应一个页面组件&#xff0c;根据菜单项动态按需加载路由 路由配置的正确写法&#xff1a; /*router/index.js*/ import Vue from vue import Router from vue-router import url from ./url import store from ../storeVue.use(Router)const router new Router({/…

【ArcGIS微课1000例】0047:制图表达(2)---河流渐变效果的实现

当我们在ArcMap中加载河流数据时,得到的效果往往如图所示,仅仅是表示河流位置的线要素,既无法真实地反映河流的实际情况,同时在出图的时候也远没有任何美化效果。 文章目录 1.创建制图表达2.添加几何效果3.使用制图规则4.使用制图表达属性覆盖警告:这些操作会对您的数据库…

操作系统思考 第二章 进程

第二章 进程 作者&#xff1a;Allen B. Downey 原文&#xff1a;Chapter 2 Processes 译者&#xff1a;飞龙 协议&#xff1a;CC BY-NC-SA 4.0 2.1 抽象和虚拟化 在我们谈论进程之前&#xff0c;我打算先定义几个东西&#xff1a; 抽象&#xff08;Abstraction&#xff09;&…

1 句代码,搞定 ASP.NET Core 绑定多个源到同一个类

问题有群友希望将路由中的信息绑定到一个Dto对象中&#xff1a;public class DDDDDto {[FromRoute(Name "collectionId")]public Guid collectionId { get; set; }[BindProperty(Name "relativeUrl")]public string relativeUrl { get; set; } }这样就不用…

redux中间件的用法

1.定义 中间件就是一个函数&#xff0c;对store.dispatch方法进行了改造&#xff0c;在发出 Action 和执行 Reducer 这两步之间&#xff0c;添加了其他功能。 2.举例 日志中间件 import { applyMiddleware, createStore } from redux; import createLogger from redux-logger; …

设置git自动补全功能(windows版本)

目录 下载 Git 的源代码 在目录中 git/contrib/completion/ 中找到 git-completion.bash 文件 将 git-completion.bash 文件改名为 .git-completion.bash 找到本机git安装目录 将.git-completion.bash文件复制到git安装目录下的etc文件夹 打开同目录下的 bash.bashrc 文件&…

用Vue搭建一个应用盒子(二):datetime-picker

接着上次的进度&#xff0c;我们已经实现了一个todo-list。它已经具备了基本的功能&#xff0c;可以新建、编辑、删除任务。但是美中不足的是&#xff0c;它的时间设定上只能通过输入一段字符串来设定&#xff0c;很不社会。我们应该完成的效果是一个time-picker&#xff0c;日…

ArcGIS实验教程——实验四十八:ArcGIS制图表达入门及案例教程

文章目录 1. 制图表达的概念1.1 什么是地图表达1.2 使用制图表达改善要素外观1.3 制图表达的优点2. 使用制图表达2.1 创建制图表达2.2 使用制图表达来符号化图层2.3 使用制图表达规则3. 地图表达实战案例1.创建制图表达2.添加几何效果3.使用制图规则4.使用制图表达属性覆盖1. 制…

PAT (Advanced Level) 1070. Mooncake (25)

简单贪心。先买性价比高的。 #include<cstdio> #include<cstring> #include<cmath> #include<vector> #include<map> #include<stack> #include<queue> #include<string> #include<algorithm> using namespace std;doub…

[转]Java 18 还未用上,Java 19 最新两大特性曝光

铁打的 Java&#xff0c;流水的版本。 不久前&#xff0c;Java 18 才正式发布&#xff0c;遵循 Oracle 六个月发一版本的频率&#xff0c;Java 19 将在今年 9 月出炉。这不&#xff0c;还没等众多开发者用上 Java 18&#xff0c;关于 Java 19 最新的两个目标功能就被披露了出…

文本生成器(bzoj 1030)

Description JSOI交给队员ZYX一个任务&#xff0c;编制一个称之为“文本生成器”的电脑软件&#xff1a;该软件的使用者是一些低幼人群&#xff0c;他们现在使用的是GW文本生成器v6版。该软件可以随机生成一些文章―――总是生成一篇长度固定且完全随机的文章—— 也就是说&…

C# 值类型和引用类型讲解

要了解值类型和引用类型&#xff0c;我们首先要知道堆和栈的区别&#xff1a;① 栈是编译期间就分配好的内存空间&#xff0c;因此你的代码中必须就栈的大小有明确的定义&#xff1b;堆是程序运行期间动态分配的内存空间&#xff0c;你可以根据程序的运行情况确定要分配的堆内存…