czahoo/api-framework

适用于外部或内部API的基本轻量级框架

v1.1.12 2017-06-23 13:20 UTC

README

使用composer安装模块后,您需要按照以下步骤操作

  1. 将src/.htaccess文件的内容添加到您的.htaccess文件中,或者如果您没有,则直接将其复制到您的根目录
  2. 为您的API创建基本文件夹(默认应该命名为'Api')
  3. 在您的Api内部创建应用文件夹(默认应该命名为'App')
  4. 创建Routing.php文件,在其中放置您的路由配置,基本结构如下定义
  5. 在您的基本控制器中实现'show'方法,如果没有传递其他方法,则默认调用此方法
  6. 创建index.php文件,代码如下所示
  7. 要调用基本控制器中的默认方法,请输入yoursitename.com/api/(对于外部API)或yoursitename.com/internal_api/(对于内部API)
  8. 要调用内部API的自定义控制器中的'method'方法,请输入yoursitename.com/api/custom_route/method

文件:index.php

// Register vendor autoloader
require_once '../vendor/autoload.php';

// Start application
session_start();
Framework::detectContext($_GET['API_TYPE']);
Framework::translateUrl($_GET['URL']);
Framework::run();

文件:Routing.php

$FRAMEWORK_ROUTING = array(
    Framework::API_TYPE_EXTERNAL => array(
        Framework::DEFAULT_CONTROLLER_ROUTE_NAME => 'Api\App\Basic\Controller\BasicControllerName',
        'custom_route' => 'Api\App\Path\To\Your\Controller',
    ),
    Framework::API_TYPE_INTERNAL => array(
        Framework::DEFAULT_CONTROLLER_ROUTE_NAME => 'Api\App\Basic\Controller\BasicControllerName',
    ),
);