https://github.com/esbenp/architect
Dynamically create API resource structures for related resources
https://github.com/esbenp/architect
Last synced: 2 months ago
JSON representation
Dynamically create API resource structures for related resources
- Host: GitHub
- URL: https://github.com/esbenp/architect
- Owner: esbenp
- License: mit
- Created: 2015-08-22T17:00:55.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-01-17T17:46:45.000Z (5 months ago)
- Last Synced: 2025-03-28T12:09:13.347Z (3 months ago)
- Language: PHP
- Homepage: http://optimus.rocks/
- Size: 25.4 KB
- Stars: 39
- Watchers: 4
- Forks: 26
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Architect
[](https://github.com/esbenp/architect/releases)
[](LICENSE)
[](https://travis-ci.org/esbenp/architect)
[](https://coveralls.io/github/esbenp/architect)
[](https://packagist.org/packages/optimus/architect)
## Introduction
Architect is used for dynamically creating new structures for API resource relationships.
Sounds confusing and pretentious?
Imagine you have a resource `Book` with a related resource `Author`.
```
Book 1-----n Author
```
### Normal embedded mode
This is how related resources are loaded by default using embedded mode.
```json
{
"books":[
{
"id":1,
"author_id":1,
"title":"How to save the world from evil",
"pages":100,
"author":{
"id":1,
"name":"Optimus Prime"
}
},
{
"id":2,
"author_id":2,
"title":"How to take over the world",
"pages":100,
"author":{
"id":2,
"name":"Megatron"
}
}
]
}
```
With Architect now you can load related resources using `ids` mode and
`sideloading` mode
### Ids mode
Only load the IDs of the related resource.
[Using the primary key property of Eloquent models is in the roadmap.](https://github.com/esbenp/architect/issues/1)
```json
{
"books":[
{
"id":1,
"author_id":1,
"title":"How to save the world from evil",
"pages":100,
"author":1
},
{
"id":2,
"author_id":2,
"title":"How to take over the world",
"pages":100,
"author":2
}
]
}
```
### Sideloading mode
Hoist the related resources into the global scope and leave behind the IDs
using the ID mode resolver.
```json
{
"author":[
{
"id":1,
"name":"Optimus Prime"
},
{
"id":2,
"name":"Megatron"
}
],
"books":[
{
"id":1,
"author_id":1,
"title":"How to save the world from evil",
"pages":100,
"author":1
},
{
"id":2,
"author_id":2,
"title":"How to take over the world",
"pages":100,
"author":2
}
]
}
```
## Usage
Architect works with normal array's (collections and resources), `Illuminate\Support\Collection`
and `Illuminate\Database\Eloquent\Model`.
```php
get();
$architect = new \Optimus\Architect\Architect;
$parsed = $architect->parseData($books, [
'author' => 'sideload' // can also be embed or ids (embed is default)
], 'books');
```
[Optimus\LaravelController](https://github.com/esbenp/laravel-controller) gives
nice convenience methods to define the Architect relationships in query parameters.
## Installation
```bash
composer require optimus/architect
```
## Standards
This package is compliant with [PSR-1], [PSR-2] and [PSR-4]. If you notice compliance oversights,
please send a patch via pull request.
[PSR-1]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
[PSR-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
[PSR-4]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/esbenp/architect/blob/master/CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [License File](https://github.com/esbenp/architect/blob/master/LICENSE) for more information.