API接口开发简述示例

作为最流行的服务端语言 PHP(PHP: Hypertext Preprocessor),在开发 API 方面,是很简单且极具优势的。API(Application Programming Interface,应用程序接口)架构,已经成为目前互联网产品开发中常见的软件架构模式,并且诞生很多专门 API 服务的公司,如:聚合数据百度 APIStore 先了解下 API :

1、API 比开发 WEB 更简洁,但可能逻辑更复杂,API 只返回结果,也就是只完成数据输出,不呈现页面, 2、WEB 开发,更多的是 GET 和 POST 请求,API 还有 PUT、DELETE 请求 3、和 WEB 开发一样,首先需要一些相关的参数,这些参数,都会由客户端传过来,也许是 GET 也许是 POST,这个需要开发团队相互之间约定好,或者制定统一规范 4、有了参数,根据应用需求,完成数据处理,例如:获取用户信息、发朋友圈、发消息、一局游戏结束数据提交等等 5、数据逻辑处理完之后,返回客户端所需要用到的相关数据,例如:用户信息数组、朋友圈列表、消息状态、游戏结果数据等等,那数据是怎么返给客户端呢?常见有 XML、JSON,设置相应的 header 并把要返回的数据直接打印出来即可 6、客户端获取到你返回的数据后,在客户端本地和用户进行交互

所以我们大概知道,API 其实不存在 Web 领域的 MVC 架构模式,若要分层的,API 也只有 M 和 C 两层,当然,后端可能会有更加复杂的架构!

通过下面一个 HTTP 协议的 API 实例来理解 PHP 怎么开发 API:

<?php
/**
* 比较标准的接口输出函数
* @param string  $info 消息
* @param integer $code 接口错误码,很关键的参数
* @param array   $data 附加数据
* $param string  $location 重定向
* @return array
*/
function var_json($info = '', $code = 10000, $data = array(), $location = '') {
    $out['code'] = $code ?: 0;
    $out['info'] = $info ?: ($out['code'] ? 'error' : 'success');
    $out['data'] = $data ?: array();
    $out['location'] = $location;
    header('Content-Type: application/json; charset=utf-8');
    echo json_encode($out, JSON_HEX_TAG);
    exit(0);
}

$a = empty($_GET['a']) ? '' : $_GET['a'];
$qq = empty($_GET['qq']) ? 0 : intval($_GET['qq']);

//假设这是数据源,如 MySQL
$data = array();
$data[85464277] = array('qq'=>85464277, 'vip'=>7,'level'=>128, 'reg_time'=>1376523234, 'qb'=>300);
$data[97656177] = array('qq'=>97656177, 'vip'=>5,'level'=>101, 'reg_time'=>1377123144, 'qb'=>300);

preg_match('/^[a-zA-Z]+$/', $a) || var_json('非法调用');
isset($data[$qq]) || var_json('用户不存在', 100001);

switch ($a) {
    //获取用户基本信息
    case 'info': 
        //你的更多业务逻辑 ...
        var_json('success', 0, $data[$qq]);
        break;
    //获取动态消息
    case 'message':
        var_json('您正在调用动态消息接口', 0);
        break;
    //获取好友列表
    case 'friends':
        var_json('你正在调用好友列表接口', 0);
        break;
    default:
        var_json('非法调用');
}

接口输出示例,返回的是一串 json:

{
        "code": 0,
        "info": "success",
        "data": {
                "qq": 85464277,
                "vip": 7,
                "level": 128,
                "reg_time": 1376523234,
                "qb": 300
        },
        "location": ""
}

json 具有很强的跨平台性,几乎每种语言都有解析 json 的函数,下面是一个 PHP 作为客户端调用的示例:

<?php 
header('Content-type:text/html;charset=utf-8'); 
$url = "http://demo.qq52o.cn/api/test/user.php?a=info&qq=85464277"; 
$arg = array( 
    'a' => 'info',
    'qq' => '85464277',
);
$query_string = http_build_query($arg);
$ch = curl_init($url.'?'.$query_string);
curl_setopt($ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_USERAGENT , 'QQ_Mobile_V5.5');
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT , 60 );
curl_setopt($ch, CURLOPT_TIMEOUT , 60);
curl_setopt($ch, CURLOPT_RETURNTRANSFER , true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
$httpcode = curl_getinfo($ch , CURLINFO_HTTP_CODE);
curl_close($ch);
if ($response === false) {
    var_dump(curl_error($ch));
} elseif ($httpcode != 200) {
    var_dump($httpcode, '接口请求失败');
} else {
    $ret = json_decode($response, true);
    var_dump($ret);
}

页面输出结果:

array(4) {
    ["code"]=>int(0)
    ["info"]=>string(7) "success"
    ["data"]=>
    array(5) {
        ["qq"]=>int(85464277)
        ["vip"]=>int(7)
        ["level"]=>int(128)
        ["reg_time"]=>int(1376523234)
        ["qb"]=>int(300)
    }
    ["location"]=>string(0) ""
}

实际项目中,我们在开发 API 时应该注意的几个点(仅供参考)

1、单文件实现多接口的形式有很多种,例如:if..elseif.. 或 switch 或 很多框架里用到的统一入口通过调用类函数的形式实现 2、数据输出建议使用 json,json 具有很强的跨平台性,大多编程语言都支持 json 解析,json 正在逐步取代 xml,成为网络数据的通用格式 3、为了保证接口安全,一定要加入鉴权体系 4、对于线上的 API,务必关闭所有错误显示,可以把错误写到日志里,PHP 中,可以通过 error_reporting(0) 屏蔽所有错误 这样做的目的,一方面是保护接口安全,防止输出不该打印的错误信息 另一方面是保证输出的是正确的数据格式,如 json,假如不是标准的 json 格式,客户端在解析时就会出错,由此影响客户端的正常运转 PS:我们平时在使用手机 APP 时,手机会闪退,多半是这个原因,即接口调用异常 5、开发 API 和 WEB 有一定的区别,如果是 WEB 的话,如果程序写的有问题,比如有个 notice 或 warning 级别的错误,在 WEB 里可能不会有什么问题,也许就只是导致 WEB 的某个部分错位或乱码。但如果是 API,就会严重调用的客户端了,如果是手机 APP,那闪推啥的,是必然的,如果同样也是 Web 调用,也可能会出现  Server Error 了 6、一定要重点考虑稳定性和响应速度,因为我们在使用手机 APP 时,都不希望 APP 经常闪推、而且希望应用很流畅 7、不要随便使用一些 PHP 开源框架,原因概括起来有两点: ①如 6 所述,客户端一般对 API 响应速度有极高要求,目前 PHP 领域的开源框架非常多,根据笔者的了解,目前比较流行的框架,普遍做的比较重,而且基本都是为 WEB 而生,因此,框架多了很多 API 用不到的东西,框架在加载和执行冗余文件时,实际是在消耗你的性能 ②如 4 和 5 所述,框架对于 WEB 开发,是件很幸福的事,但对于 API 而言,你实在不敢想象它会给你出什么岔子,因为很多框架并没有全面的考虑到 API 场景

沈唁志|一个PHPer的成长之路! 原创文章采用CC BY-NC-SA 4.0协议进行许可,转载请注明:转载自:API接口开发简述示例

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Linyb极客之路

分布式事务的实现原理

事务是数据库系统中非常有趣也非常重要的概念,它是数据库管理系统执行过程中的一个逻辑单元,它能够保证一个事务中的所有操作要么全部执行,要么全不执行;在 SOA 与...

17630
来自专栏一名合格java开发的自我修养

交易系统使用storm,在消息高可靠情况下,如何避免消息重复

概要:在使用storm分布式计算框架进行数据处理时,如何保证进入storm的消息的一定会被处理,且不会被重复处理。这个时候仅仅开启storm的ack机制并不能解...

11130
来自专栏Golang语言社区

Golang协程与通道整理

协程goroutine 不由OS调度,而是用户层自行释放CPU,从而在执行体之间切换。Go在底层进行协助实现 涉及系统调用的地方由Go标准库...

28270
来自专栏Java后端技术栈

关于缓存命中率的几个关键问题!

不命中:无法直接通过缓存获取到想要的数据,需要再次查询数据库或者执行其它的操作。原因可能是由于缓存中根本不存在,或者缓存已经过期。

30610
来自专栏smy

一张图解释负载均衡

首先当大量用户访问时候,先请求到nignx服务器,因为nignx对于高并发支持较好,所以由nignx服务器将访问需求分配给不同的apache服务器,apache...

18130
来自专栏zhangdd.com

make: 警告:检测到时钟错误。您的创建可能是不完整的 问题解决方法

今天编译nginx源码,make的时候也出现了这个问题,报错”make: 警告:检测到时钟错误。您的创建可能是不完整的。”

12840
来自专栏知晓程序

小程序有更新:开发环境不再限制白名单

19220
来自专栏张戈的专栏

单机MySQL数据库优化推荐的编译安装参数

MySQL 编译参数多而复杂,让新手感到很头大,如果是正式生成环境安装 MySQL,没有充足的时间去研究每一个参数代表的意义,个人建议使用余洪春前辈整理的编译参...

33530
来自专栏Golang语言社区

Golang协程与通道整理

协程goroutine 不由OS调度,而是用户层自行释放CPU,从而在执行体之间切换。Go在底层进行协助实现 涉及系统调用的地方由Go标准库...

37670
来自专栏IT技术精选文摘

架构师眼中的高并发架构

28550

扫码关注云+社区

领取腾讯云代金券