bigoen/api-bridge

APi bridge for api projects.

v1.4.4 2025-03-07 01:43 UTC

Requires

• php: >=8.1
• bigoen/api-bridge-converter: ^1.0
• symfony/http-client: ^4.0|^5.0|^6.0|^7.0
• symfony/property-access: ^4.0|^5.0|^6.0|^7.0
• symfony/property-info: ^4.0|^5.0|^6.0|^7.0
• symfony/serializer: ^4.0|^5.0|^6.0|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0

LGPL-3.0

• Şafak Saylam

README

Install:

composer require bigoen/api-bridge

SimpleClient

Create model:

<?php

namespace App\Model;

class Example 
{
    public ?string $name = null;
    public ?string $email = null;
}

If you want error class, create model:

<?php

namespace App\Model;

class Error 
{
    public ?string $status = null;
    public ?string $message = null;
}

Create client:

use App\Model\Example;
use App\Model\Error;
use Symfony\Component\HttpClient\HttpClient;
use Bigoen\ApiBridge\HttpClient\SimpleClient;

$httpClient = HttpClient::create();
$client = new SimpleClient($httpClient); 
$client
    ->setBaseUrl("http://example.com")
    ->setClass(Example::class)
    ->setThrowClass(Error:class)
    ->setOptions([
        // Set http client request options.
    ]);

// all objects.
$client->setPath("/api/examples")->getAll();

// get object with id.
$client->setPath("/api/examples/{id}")->setId(1)->get();

// post object.
$model = new Example();
$model->name = 'Test';
$model->email = '[e-mail]';
$postModel = $client->setPath("/api/examples")->post($model);

// put object.
$model = $client->setPath("/api/examples/{id}")->setId(1)->get();
$model->name = 'New Name';
$model = $client->setPath("/api/examples/{id}")->put($model);

// delete object.
$isDelete = $client->setPath("/api/examples/{id}")->setId(1)->delete();

JsonldClient

Create model:

<?php

namespace App\Model;

use Bigoen\ApiBridge\Bridge\ApiPlatform\Model\Traits\JsonldModelTrait;

class Example 
{
    use JsonldModelTrait;

    public ?string $name = null;
    public ?string $email = null;
}

Create client for ApiPlatform projects or jsonld apis:

use App\Model\Example;
use Symfony\Component\HttpClient\HttpClient;
use Bigoen\ApiBridge\Bridge\ApiPlatform\HttpClient\JsonldClient;

$httpClient = HttpClient::create();
$client = new JsonldClient($httpClient); 
$client
    ->setBaseUrl("http://example.com")
    ->setClass(Example::class)
    ->setOptions([
        // Set http client request options.
    ]);

// all objects.
$pageOne = $client->setPath("/api/examples")->getAll();
// get next page objects.
$pageTwo = $client->setPath($pageOne->nextPagePath)->getAll();

// get object with id.
$client->setPath("/api/examples/{id}")->setId(1)->get();

// post object.
$model = new Example();
$model->name = 'Test';
$model->email = '[e-mail]';
$postModel = $client->setPath("/api/examples")->post($model);

// put object.
$model = $client->setPath("/api/examples/{id}")->setId(1)->get();
$model->name = 'New Name';
$model = $client->setPath("/api/examples/{id}")->put($model);

// delete object.
$isDelete = $client->setPath("/api/examples/{id}")->setId(1)->delete();

Convert api values in tree. Details: https://github.com/bigoen/api-bridge-converter