A minimal skeleton for chubbyphp-framework
A simple skeleton to build api's based on the chubbyphp-framework.
- php: ^8.0
- chubbyphp/chubbyphp-api-http: ^5.0.1
- chubbyphp/chubbyphp-clean-directories: ^1.2
- chubbyphp/chubbyphp-cors: ^1.4
- chubbyphp/chubbyphp-decode-encode: ^1.0.1
- chubbyphp/chubbyphp-deserialization: ^3.5.2
- chubbyphp/chubbyphp-framework: ^5.0.3
- chubbyphp/chubbyphp-framework-router-fastroute: ^2.0.1
- chubbyphp/chubbyphp-http-exception: ^1.0.1
- chubbyphp/chubbyphp-laminas-config: ^1.3
- chubbyphp/chubbyphp-laminas-config-doctrine: ^2.0.3
- chubbyphp/chubbyphp-laminas-config-factory: ^1.2
- chubbyphp/chubbyphp-negotiation: ^1.9
- chubbyphp/chubbyphp-serialization: ^3.3.1
- chubbyphp/chubbyphp-validation: ^3.12.4
- doctrine/orm: ^2.14
- monolog/monolog: ^2.8
- ramsey/uuid: ^4.7
- slim/psr7: ^1.6
- symfony/console: ^6.0.17
Add the following environment variable to your system, for example within
export USER_ID=$(id -u) export GROUP_ID=$(id -g)
docker-compose up -d docker-compose exec php bash
- GET https://localhost/api/pets?sort[name]=asc
- POST https://localhost/api/pets
- GET https://localhost/api/pets/8ba9661b-ba7f-436b-bd25-c0606f911f7d
- PUT https://localhost/api/pets/8ba9661b-ba7f-436b-bd25-c0606f911f7d
- DELETE https://localhost/api/pets/8ba9661b-ba7f-436b-bd25-c0606f911f7d
composer create-project chubbyphp/petstore myproject "dev-chubbyphp"
Collections are sortable, filterable paginated lists of models.
Factories to create collections, model or whatever you need to be created.
Mappings are used for deserialization, orm, serialization and validation defintions. They are all done in PHP.
Models, entities, documents what ever fits your purpose the best.
Repositories get data from storages like databases, elasticsearch, redis or whereever your models are stored or cached.
RequestHandler alias Controller, or Controller actions to be more precise. There is a directory with generic crud controllers. If you like the idea adapt them for your generic use case, if not drop them. I highly recommend to not extend them.
Service factories are the glue code of the dependeny injection container.
2023 Dominik Zogg