Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nadar/yii-rest-client
A Yii Framework Component in order to work with LUYA headless REST Client
https://github.com/nadar/yii-rest-client
Last synced: 29 days ago
JSON representation
A Yii Framework Component in order to work with LUYA headless REST Client
- Host: GitHub
- URL: https://github.com/nadar/yii-rest-client
- Owner: nadar
- License: mit
- Created: 2020-09-02T12:30:52.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-30T12:05:15.000Z (almost 4 years ago)
- Last Synced: 2024-10-08T16:17:09.082Z (about 1 month ago)
- Language: PHP
- Size: 31.3 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Yii Framework REST Client
A Yii Framework Component in order to work with the LUYA headless REST Client. The LUYA REST Client is an Active Record similar solution for APIs.
It works with Yii Framework out of the box, therefore those things are included:
+ Use `fields` in your requests
+ Use `sort` in your requests
+ Working with `expand`
+ Caching
+ CRUD (Create new records, Read records, Update records, Delete records) API operations
+ Similar to Yii Framework Active Query and Active Record
[](https://codeclimate.com/github/nadar/yii-rest-client/maintainability)
[](https://codeclimate.com/github/nadar/yii-rest-client/test_coverage)
## Installation
Installation via composer
```sh
composer require nadar/yii-rest-client
```
## Usage & Dokumentation
Configure your API Client:
```php
'components' => [
'api' => [
'class' => 'Nadar\YiiRestClient\Api',
'server' => 'https://myapi.com',
'accessToken' => '...',
]
]
```
> **To see all LUYA Headless functions see the [LUYA Headless Documentation](https://github.com/luyadev/luya-headless)**
Now add your Rest Model (Active Endpoint), this represents the Model on the client side. It provides basic getter and setter methods same as Yii Framework.
```php
class ApiCars extends \luya\headless\ActiveEdnpoint
{
public $id;
public $name;
public $year;
public function getEndpointName()
{
return '{{%cars}}';
}
}
```
The above example assumes the full endpoint is `https://myapi.com/cars`.
Working with the Model to make CRUD operations like list, edit, save.
Foreach Data (Will make a GET request):
```php
foreach (ApiCars::find()->all(Yii::$app->api->client)->getModels() as $car) {
var_dump($car->name);
}
```
View One and Update the record (Will make a PUT request):
```php
$car = ApiCars::viewOne(1, Yii::$app->api->client);
echo $car->name; // f.e BMW
$car->name = 'Mercedes';
$car->save(Yii::$app->api->client);
```
Add new entry (will make a POST request):
```php
$car = new ApiCars();
$car->name = 'Honda';
$car->save(Yii::$app->api->client);
```
> **To see all LUYA Headless functions see the [LUYA Headless Documentation](https://github.com/luyadev/luya-headless)**