README

安装

$ composer require hexcores/api-support

响应

API Support 提供了总共4种用于JSON响应的方法。可用方法有 -

• Response::ok($data, array $headers = [])
• Response::missing($message = null, array $headers = [])
• Response::error($message, $status = 500, array $headers = [])
• Response::unauthorized($message = null, array $headers = [])

示例 -

use Hexcores\Api\Facades\Response as ApiResponse;

class UserApiController extends Controller 
{
	public function create()
	{
		if ( ! User::can('create'))
		{
			// User has not permission to create new record,
			// So response unauthorized with status 401
			return ApiResponse::unauthorized();
		}

		if ( $user = User::create(Input::all()))
		{
			return ApiResponse::ok($user);
		}
		
		// User creation has a problem,
		// So response error with status 500
		return ApiResponse::error('User creationo is fail');
	}

	public function show($id)
	{
		$user = User::find($id);

		if ( is_null($user))
		{
			return ApiResponse::missing();
		}

		return ApiResponse::ok($user);
	}
}

您可以为每种响应使用辅助函数。

• response_ok()
• response_missing()
• response_error()
• response_unauthorized()

中间件

• VerifyApiRequestHeader

VerifyApiRequestHeader

VerifyApiRequestHeader 中间件用于API请求访问检查。您需要传递 X-API-KEY 和 X-API-SECRET 头部信息进行请求。

注意：在 .env 文件中添加 X-API-KEY 和 X-API-SECRET

如果您想添加多个密钥，请在 .env 文件中的密钥字符串之间使用逗号。

示例

X-API-KEY=first_key,second_key,third_key
X-API-SECRET=first_secret,second_secret,third_secret

密钥生成器

您可以使用 artisan 命令生成新的密钥。

命令使用 -

生成新的密钥并添加到 .env 文件中

php artisan api:key

显示从 .env 文件中当前注册的密钥。

php artisan api:key --current

仅打印新的密钥

php artisan api:key --print

用从 .env 文件中当前注册的新密钥替换

php artisan api:key --replace

在 app/console/Kernel.php 中添加 artisan 命令

protected $commands = [
    \App\Console\Commands\Inspire::class,
    // Other commands.
	Hexcores\Api\Console\ApiKeyGenerate,    
];