README

提供了一种方便的方式，可以从Laravel应用程序设置和调用RAWG API。有关RAWG端点文档、速率限制和许可信息，请访问RAWG API Docs。

依赖

• PHP cURL
• PHP 7

安装

通过Composer安装此包

composer require dherran/laravel-rawg

配置

使用 php artisan vendor:publish --provider="Rawg\RawgServiceProvider" 发布配置文件，或者简单地复制包配置文件并将其粘贴到 config/rawg.php

打开配置文件 config/rawg.php 并添加您在https://rawg.io/apidocs可获取的应用API密钥。

    /*
    |----------------------------------
    | API Key
    |------------------------------------
    */
    
    'api_key' => 'XYZ',

根据RAWG API文档：每个API请求都应该有一个API密钥。如果您不提供它，我们可能会禁止您的请求。

用法

以下是一个向游戏端点发起请求的示例

$response = \Rawg::load('games')->setParams([
                'page' => 1,
                'page_size' => 40,
                'ordering' => '-rating',
            ])->get();

或查找特定游戏的详细信息

$response = \Rawg::load('games/{id}')->setParams([
                'id' => 86,
            ])->get();

原则是加载方法接收RAWG提供的端点。

可用方法

• load( $endpoint )
• setParamByKey($key, $value)
• setParams($parameters)
• get()
• get($key)

load( $serviceName ) - 准备端点名称

接受字符串作为参数。您可以在RAWG API文档中找到所有端点。返回自身的引用。

\Rawg::load('publishers') 
... 

setParamByKey( $key, $value ) - 使用键：值对设置请求参数

接受两个参数

• key - 请求体参数名称
• value - 请求体参数值

深层嵌套数组可以使用“点”表示法来分配值。
返回自身的引用。

$endpoint = \Rawg::load('publishers')
   ->setParamByKey('page', 3)
   ->setParamByKey('page_size', 10)
    ...

setParams( $parameters) - 一次性设置所有请求参数

接受参数数组
返回自身的引用。

$response = \Rawg::load('games')
                ->setParam([
                   'search' => 'monster',
                   'tags' => 'multiplayer',
                ])
...

• get() - 通过GET执行RESTful请求
• get($key) - 筛选请求结果。支持点表示法

$response = \Rawg::load('games')
                ->setParamByKey('search', 'monster')
                 ->get();

带有关键字的示例

$response = \Rawg::load('games')
                ->setParamByKey('search', 'monster')
                 ->get('results');

支持

请在GitHub上提交问题