grape动态PHP结构(三)——API接口

简介:

一、app视图与控制器

1)路由

这里的v1、v2就是模块,由于客户端版本一直在迭代的,那么一些老版本的客户端调用的接口就得保留起来,使得兼容。新版本就直接调用新接口。

还有一种是写html页面,在客户端展示,只要把template文件夹和data文件夹加上就可以了。

Controller的配置如下,注意ismodule是true,module_list中的array

$InitPHP_conf['ismodule'] = true; //开启module方式
$InitPHP_conf['controller']['path']                  = 'controller';
$InitPHP_conf['controller']['controller_postfix']    = 'Controller'; //控制器文件后缀名
$InitPHP_conf['controller']['action_postfix']        = ''; //Action函数名称后缀
$InitPHP_conf['controller']['default_controller']    = 'index'; //默认执行的控制器名称
$InitPHP_conf['controller']['default_action']        = 'index'; //默认执行的Action函数
$InitPHP_conf['controller']['module_list']           = array('v1','v2'); //module白名单
$InitPHP_conf['controller']['default_module']        = 'v1'; //默认执行module
$InitPHP_conf['controller']['default_before_action'] = 'before'; //默认前置的ACTION名称
$InitPHP_conf['controller']['default_after_action']  = 'after'; //默认后置ACTION名称

这里顺便说下InitPHP的路由管理。InitPHP的框架URL路由分为三种形式,原生、path模式、rewrite模式,HTML模式。我这边用的是rewrite模式。

1.原生模式:index.php?c=index&a=run

2.rewrite模式:/index/run/id=1 (需要开启服务器rewrite模块,并且配置.htaccess)

3.path模式:/index/run/id/1 (需要开启服务器rewrite模块,并且配置.htaccess)

4.html模式: user-index-run.htm?uid=100 (需要开启服务器rewrite模块,并且配置.htaccess)

 

2)模拟session

这里模拟的方法比较简单而粗暴。

在登录的时候,会生成一串字符,然后保存到用户表中,这串字符会返回给客户端,作为session。

在登录后客户端会将这串字符传过来,服务器再根据这串字符在搜索用户,从未获取用户信息,并判断是否已经登录。

 

二、apiController通用控制器类

public function __construct() {
        parent::__construct();
        
        $this->controller_name = $this->getC();
        $this->action_name = $this->getA();
        $this->module_name = $this->getM();
        
        //访问参数日志记录
        $this->_logVisit();

        //API统一接口为post提交
        if (!$this->controller->is_post()) {
            $this->output(constHelper::API_STATUS_NEED_POST, '必须为POST请求');
        }
        
        /**
         * 请求参数示例
         * __ua=Android 4.4.4//MI 3W//26//2.0//865645022129866//////WIFI&
         * __timestamp=1441854121116&
         * mobile=13800138000&
         * __version=2.0&
         * __device=android&type=2&
         * __key=67543fd413ce4d281fc93306597acb66
         */
        $device = $this->p('__device'); //客户端名称
        $timestamp = $this->p('__timestamp'); //客户端时间戳
        $key = $this->p('__key'); //客户端加密指纹
        $session = $this->p('__session'); //客户端SESSION
        $version = substr($this->p('__version'), 0, 5); //客户端版本
        
        //客户端最低版本号要求
        if (strnatcmp($version, constHelper::MIN_VERSION_ALLOWED) < 0) { //客户端需要升级
            $this->output(constHelper::API_STATUS_NEED_UPGRADE, '客户端需要升级');
        }
        
        //检查密钥
        $this->_checkSecretKey($device, $timestamp, $key);
        
        //判断是否需要验证登录
        $needCheck = $this->_checkLogin();
        if($needCheck && empty($session)) {
            $this->output(constHelper::API_STATUS_NEED_LOGIN, '请先登录');
        }
        
        //根据session获取用户信息
        if(!empty($session)){
            $memberModel = InitPHP::getMysqlDao('member');
            $this->member = $memberModel->getMemberBySession($session);
        }
        
        //session没有获取到相关信息 也要做跳转
        if($needCheck && empty($this->member)) {
            $this->output(constHelper::API_STATUS_NEED_LOGIN, '请先登录');
        }
}

1)访问参数日志记录

当客户端发起一个请求的时候,会带上很多参数,例如操作系统、当前版本号、时间戳、口令、网络、应用市场等信息。

调用$this->_logVisit();将这些信息全部存到MongoDB中,便于以后调试与追踪。并且在返回参数的时候,将返回参数更新到这条请求记录中。

 

2)output返回参数

返回参数的格式如下:

 {
    "code":1000,
    "msg":"hello\u6210\u529f",
    "data":{
        "result":1,
        "obj":{"id":"55f57a4aa0105"}
    }
}    

code:是各种通用的错误编码,我写在了libraray/helper/dict/constHelper中,如上面的代码所示,当验证出现错误的时候,会显示响应的code,并返回

msg:就是提示语言,这里做了Unicode编码

data:返回的就是各种自定义参数,这里仅列举了通用的两种

result:也是类似于code的定义,不同的是针对的是特定请求中的返回码

obj:返回的就是个自定义对象,也可以是数组

 

3)密钥匹配

为了保证请求的合法性,在客户端和服务器端约定一个密钥,客户端在根据这个密钥做加密后,传过来给服务器端,服务端再加密然后做匹配。

服务器端将密钥设置在defined文件中,IOS,Android可以定义的不同

define('API_IOS_KEY', 'DF_A98=D^&7$^%*9CNAhj0UO!!LM11');
define('API_ANDROID_KEY', 'KU98&)dsf8%@kji89dfadJK-800i122');
define('API_UNKNOW_KEY', 'jfdsfd798hj+@(*kb66578-223q670933');

而验证的规则也很简单,时间戳+密钥再MD5加密

private function _checkSecretKey($device, $timestamp, $key) {
        //提取私有密钥
        $privateKey = '';
        switch (strtolower($device)) {
            case 'ios':
                $privateKey = API_IOS_KEY;
                break;
            case 'android':
                $privateKey = API_ANDROID_KEY;
                break;
            default:
                $privateKey = API_UNKNOW_KEY;
                break;
        }
        
        $keySource = $privateKey . $timestamp;
        //客户端安全认证失效
        if (empty($key) || ($key != md5($keySource))) {
            $this->outputCom(constHelper::API_STATUS_AUTH_FAIL, '安全认证失败');
        }
}

 

4)各种验证

1.第一个验证是只接收post请求,这里直接使用了InitPHP中的Request API

2.客户端最低版本号验证,有时候客户端需要强制升级

3.登录验证,这里有多种情况,有些API是不需要登录的,有些是需要登录的,而有些是既可以登录也可以不登录

 

三、API调试工具

在交付给客户端之前,自己肯定要先测试一下的,这就需要一个简易工具了,当然也可以选择一些强大的工具,例如firefox的httprequester等。

在tool文件夹下面,我已经把这个工具放在里面了,执行页面如下:

 

工具的文件目录也很淳朴,就五个文件,有两个地方需要配置:

 

1)在indexhtml中data-domain属性,修改为你当前的api域名,在第13行左右

 

2)在tk.php中,修改数据库连接参数,以及客户端密钥

 

 

GitHub地址:

https://github.com/pwstrick/grape


    本文转自 咖啡机(K.F.J)   博客园博客,原文链接:http://www.cnblogs.com/strick/p/4805700.html,如需转载请自行联系原作者


相关文章
|
2月前
|
JSON 数据挖掘 API
1688API最新指南:商品详情接口接入与应用
本指南介绍1688商品详情接口的接入与应用,该接口可获取商品标题、价格、规格、库存等详细信息,适用于电商平台开发、数据分析等场景。接口通过商品唯一标识查询,支持HTTP GET/POST请求,返回JSON格式数据,助力开发者高效利用1688海量商品资源。
|
2月前
|
JSON 数据挖掘 API
京东API接口最新指南:店铺所有商品接口的接入与使用
本文介绍京东店铺商品数据接口的应用与功能。通过该接口,商家可自动化获取店铺内所有商品的详细信息,包括基本信息、销售数据及库存状态等,为营销策略制定提供数据支持。此接口采用HTTP请求(GET/POST),需携带店铺ID和授权令牌等参数,返回JSON格式数据,便于解析处理。这对于电商运营、数据分析及竞品研究具有重要价值。
|
3月前
|
存储 供应链 监控
1688商品数据实战:API搜索接口开发与供应链分析应用
本文详细介绍了如何通过1688开放API实现商品数据的获取与应用,涵盖接入准备、签名流程、数据解析存储及商业化场景。开发者可完成智能选品、价格监控和供应商评级等功能,同时提供代码示例与问题解决方案,确保法律合规与数据安全。适合企业开发者快速构建供应链管理系统。
|
12天前
|
JSON 供应链 API
1688 买家订单,订单物流,订单回传接口系列(1688 寻源通 API)
1688寻源通API为开发者提供买家订单、订单物流及订单回传三大接口,助力企业实现订单管理、物流跟踪与信息反馈的自动化。买家订单接口可查询订单详情;订单物流接口支持实时跟踪物流状态;订单回传接口确保企业系统与平台数据同步。结合Python示例代码,企业可轻松集成这些功能,优化内部管理、提升客户体验并支持数据驱动决策。适用于电商订单管理、物流服务和数据分析等场景。
|
3月前
|
前端开发 Cloud Native Java
Java||Springboot读取本地目录的文件和文件结构,读取服务器文档目录数据供前端渲染的API实现
博客不应该只有代码和解决方案,重点应该在于给出解决方案的同时分享思维模式,只有思维才能可持续地解决问题,只有思维才是真正值得学习和分享的核心要素。如果这篇博客能给您带来一点帮助,麻烦您点个赞支持一下,还可以收藏起来以备不时之需,有疑问和错误欢迎在评论区指出~
Java||Springboot读取本地目录的文件和文件结构,读取服务器文档目录数据供前端渲染的API实现
|
2月前
|
JSON API 开发者
京东API最新指南:商品视频接口接入与应用
在电商领域,商品视频能有效提升销售业绩。京东商品视频接口助力开发者获取商品视频信息(播放链接、时长、格式、封面图等),通过 HTTP GET/POST 请求返回 JSON 数据,便于集成到各类应用中,优化展示效果与用户体验。本指南详解接口接入与使用方法。
|
3月前
|
PHP 数据库
【YashanDB知识库】PHP使用OCI接口使用数据库绑定参数功能异常
【YashanDB知识库】PHP使用OCI接口使用数据库绑定参数功能异常
|
3月前
|
机器学习/深度学习 JSON 算法
淘宝拍立淘按图搜索API接口系列的应用与数据解析
淘宝拍立淘按图搜索API接口是阿里巴巴旗下淘宝平台提供的一项基于图像识别技术的创新服务。以下是对该接口系列的应用与数据解析的详细分析
|
3月前
|
存储 JSON API
淘宝商品详情API接口概述与JSON数据示例
淘宝商品详情API是淘宝开放平台提供的核心接口之一,为开发者提供了获取商品深度信息的能力。以下是技术细节和示例:
|
3月前
|
存储 缓存 监控
如何高效爬取天猫商品数据?官方API与非官方接口全解析
本文介绍两种天猫商品数据爬取方案:官方API和非官方接口。官方API合法合规,适合企业长期使用,需申请企业资质;非官方接口适合快速验证需求,但需应对反爬机制。详细内容涵盖开发步骤、Python实现示例、反爬策略、数据解析与存储、注意事项及扩展应用场景。推荐工具链包括Playwright、aiohttp、lxml等。如需进一步帮助,请联系作者。
下一篇
oss创建bucket