phalouvas/httpquery

Laravel Http driver for eloquent.

dev-main 2021-10-11 07:36 UTC

Requires

• php: ^7.2|^8.0
• ext-json: *
• illuminate/database: ^6.9|^7.0|^8.0
• illuminate/http: ^6.9|^7.0|^8.0

Requires (Dev)

• mockery/mockery: ^1.0
• orchestra/testbench: ^4.0|^5.0|^6.0
• phpunit/phpunit: ^8.0|^9.3

mit

• Panayiotis Halouvas

• http
• driver
• laravel

README

The library allows to create and assign an API connection to Laravel 8 Eloquent models and use Laravel query builder to build a query string and get data as if you get data from a database connection. It also allows to use Eloquent relationships.

Once developers define the configuration of a new API connection and make the related model classes use that connection, they don't need to think about API calls, authentication, etc. They just work with those models as if they are regular models that have a MySQL connection. However, the library only supports retrieving data from an API service.

The package must be installed both on the source and destination Laravel instance.

Installation & Configuration

To install composer require phalouvas/httpquery

If not autoloaded (e.g. in Lumen) add line: $app->register(\phalouvas\Httpquery\ServiceProvider::class); before $app->withEloquent();

In file config\database.php add below entry in connections and setup accordingly. Below is an example

'connections' => [
  ...
  'http_msms' => [
        'driver' => 'httpquery',
        'database' => env('APP_MSMS_URL', 'https://api.sms.to/'),
        'port' => env('APP_MSMS_PORT', ''),
        'api_key' => env('APP_MSMS_API_KEY', 'api_key'),
        'connection' => env('APP_MSMS_CONNECTION', 'mysql'),
    ],
],

In order to accept routes. Add in your route file below entry: Route::post('/query', '\phalouvas\Httpquery\QueryController@query');

In your model add: protected $connection = 'http_msms';