README

描述

这个库为 Skeleton 项目提供了一个 API

安装

通过 composer 安装

composer require tigron/skeleton-package-api

如何安装

在您的应用程序中创建一个扩展自 Skeleton\Package\Api\Web\Module\Index 的索引模块

<?php
/**
 * Module Index
 *
 * @author Christophe Gosiau <christophe@tigron.be>
 * @author Gerry Demaret <gerry@tigron.be>
 * @author David Vandemaele <david@tigron.be>
 */

class Web_Module_Index extends \Skeleton\Package\Api\Web\Module\Index {
}

此模块将为 API 创建用户界面。用户界面基于调用模块中的 docblocks

创建一个调用模块

<?php
/**
 * Module Index
 *
 * @author Christophe Gosiau <christophe@tigron.be>
 * @author Gerry Demaret <gerry@tigron.be>
 * @author David Vandemaele <david@tigron.be>
 */

class Web_Module_User extends \Skeleton\Package\Api\Web\Module\Call {

	/**
	 * Get by id
	 *
	 * Get a user by his ID
	 *
	 * @access public
	 * @param int $id
	 * @return array $user
	 */
	public function call_getById() {
		$user = User::get_by_id($_REQUEST['id']);
		return $user->get_info();
	}
}

确保每个调用方法都以 'call_' 开头。同时确保 docblocks 包含正确的变量。这些将作为 $_REQUEST 参数可用

安全

每个 API 请求都会检查正确的凭证。API 密钥可以通过

\Skeleton\Package\Api\Config::$api_keys = [ 'KEY1', 'KEY2' ];

每个 API 调用现在都需要在它的 GET 参数中包含一个有效的 API 密钥

http://api.myapplication.tld/user?call=getById&id=1&api_key=KEY1

要禁用身份验证，将 Config 值设置为 false

\Skeleton\Package\Api\Config::$api_keys = false;

为了获得更多控制，每个调用在继续之前将执行一个 'secure-method'。如果您的应用程序需要更细粒度的用户权限，您可以在这里实现它们。

	/**
	 * Secure
	 *
	 * @access public
	 * @return bool $secured
	 */
	public function secure() {
	    $api_key = $_REQUEST['api_key'];
	    // Only keys that start with letter A are allowed
	    if ($api_key[0] == 'A') {
	    	return true;
	    }
	    return false;
	}