Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devtheorem/phaster
A PSR-7 compatible library for easily making CRUD API endpoints
https://github.com/devtheorem/phaster
php psr-7 rest-api
Last synced: 8 days ago
JSON representation
A PSR-7 compatible library for easily making CRUD API endpoints
- Host: GitHub
- URL: https://github.com/devtheorem/phaster
- Owner: DevTheorem
- License: mit
- Created: 2016-08-15T00:07:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T03:30:28.000Z (23 days ago)
- Last Synced: 2024-10-24T20:46:04.120Z (22 days ago)
- Topics: php, psr-7, rest-api
- Language: PHP
- Homepage:
- Size: 118 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Phaster
Phaster is a PSR-7 compatible library for easily making CRUD API endpoints.
It enables mapping API fields to columns in the database or from a select query,
and implementing custom validation or row modification logic.
Built on top of [PeachySQL](https://github.com/devtheorem/peachy-sql).
## Installation
`composer require devtheorem/phaster`
## Usage
Create a class extending `Entities` and implement the `getMap()` method. By default, the table
name will be inferred from the class name, and all mapped columns in this table will be selected.
To join other tables and alter output values, implement the `getBaseQuery()` and `getSelectProps()` methods.
Pass the callable returned by the route handling functions to your Slim or other PSR-7 compatible framework.
```php
'uname',
'firstName' => 'fname',
'lastName' => 'lname',
'isDisabled' => 'disabled',
'role' => [
'id' => 'role_id',
],
];
}
protected function getSelectProps(): array
{
// map additional properties for selecting/filtering and set output options
return [
new Prop('id', col: 'u.user_id'),
new Prop('isDisabled', col: 'u.disabled', type: 'bool'),
new Prop('role.id', col: 'u.role_id'),
new Prop('role.name', col: 'r.role_name'),
];
}
protected function getBaseQuery(QueryOptions $options): string
{
return "SELECT {$options->getColumns()}
FROM Users u
INNER JOIN Roles r ON r.role_id = u.role_id";
}
protected function getDefaultSort(): array
{
return ['username' => 'asc'];
}
}
```
If it is necessary to bind parameters in the base query, use `getBaseSelect` instead:
```php
use DevTheorem\PeachySQL\QueryBuilder\SqlParams;
// ...
protected function getBaseSelect(QueryOptions $options): SqlParams
{
$sql = "WITH num_orders AS (
SELECT user_id, COUNT(*) as orders
FROM Orders
WHERE category_id = ?
GROUP BY user_id
)
SELECT {$options->getColumns()}
FROM Users u
INNER JOIN num_orders n ON n.user_id = u.user_id";
return new SqlParams($sql, [321]);
}
// ...
```
```php
get('/users', $phaster->search(Users::class));
$app->get('/users/{id}', $phaster->getById(Users::class));
$app->post('/users', $phaster->insert(Users::class));
$app->put('/users/{id}', $phaster->update(Users::class));
$app->patch('/users/{id}', $phaster->patch(Users::class));
$app->delete('/users/{id}', $phaster->delete(Users::class));
```
### Example API request/response
GET `https://example.com/api/users?q[firstName]=Ted&q[isDisabled]=0&fields=id,username,role`
```json
{
"offset": 0,
"limit": 25,
"lastPage": true,
"data": [
{
"id": 5,
"username": "Teddy01",
"role": {
"id": 1,
"name": "Admin"
}
},
{
"id": 38,
"username": "only_tj",
"role": {
"id": 2,
"name": "Standard"
}
}
]
}
```
## Author
Theodore Brown
## License
MIT