dotkernel / api
Dotkernel API
Installs: 55
Dependents: 0
Suggesters: 0
Security: 0
Stars: 44
Watchers: 11
Forks: 4
Open Issues: 5
Type:project
Requires
- php: ~8.2.0 || ~8.3.0
- ext-gd: *
- ext-json: *
- dotkernel/dot-cache: ^4.0
- dotkernel/dot-cli: ^3.5.0
- dotkernel/dot-data-fixtures: ^1.2.2
- dotkernel/dot-dependency-injection: ^1.0
- dotkernel/dot-errorhandler: ^4.0.0
- dotkernel/dot-mail: ^5.1.0
- dotkernel/dot-response-header: ^3.2.3
- laminas/laminas-component-installer: ^3.4.0
- laminas/laminas-config-aggregator: ^1.14.0
- laminas/laminas-hydrator: ^4.15.0
- laminas/laminas-inputfilter: ^2.29.0
- laminas/laminas-stdlib: ^3.19.0
- mezzio/mezzio: ^3.19.0
- mezzio/mezzio-authentication-oauth2: ^2.8.0
- mezzio/mezzio-authorization-acl: ^1.10.0
- mezzio/mezzio-authorization-rbac: ^1.7.0
- mezzio/mezzio-cors: ^1.11.1
- mezzio/mezzio-fastroute: ^3.11.0
- mezzio/mezzio-hal: ^2.9
- mezzio/mezzio-problem-details: ^1.13.1
- mezzio/mezzio-twigrenderer: ^2.15.0
- ramsey/uuid-doctrine: ^2.1.0
- roave/psr-container-doctrine: ^5.2.1
- symfony/filesystem: ^7.0.3
- zircote/swagger-php: ^4.10
Requires (Dev)
- laminas/laminas-coding-standard: ^3.0
- laminas/laminas-development-mode: ^3.12.0
- mezzio/mezzio-tooling: ^2.9.0
- phpstan/phpstan: ^2.0
- phpstan/phpstan-doctrine: ^2.0
- phpstan/phpstan-phpunit: ^2.0
- phpunit/phpunit: ^10.5.10
- roave/security-advisories: dev-latest
- symfony/var-dumper: ^7.1
README
Dotkernel API is a PHP skeleton app for building REST APIs using Laminas and Mezzio components and implements standards like PSR-3, PSR-4, PSR-7, PSR-11 and PSR-15.
Dotkernel API is an alternative for legacy Laminas API Tools (formerly Apigility) applications and is based on Enrico Zimuel's Zend Expressive API - Skeleton example.
Live demo.
Documentation
Documentation is available at: https://docs.dotkernel.org/api-documentation/
Badges
Getting Started
Clone the project
Using your terminal, navigate inside the directory you want to download the project files into. Make sure that the directory is empty before proceeding to the download process. Once there, run the following command:
git clone https://github.com/dotkernel/api.git .
Install the project dependencies
composer install
Development mode
Do not enable development mode in production!
If you're installing the project for development, you should enable development mode by running:
composer development-enable
You can disable development mode by running:
composer development-disable
You can check the development status by running:
composer development-status
Prepare config files
- duplicate
config/autoload/cors.local.php.dist
asconfig/autoload/cors.local.php
<- if your API is consumed by another application, make sure configure theallowed_origins
- duplicate
config/autoload/local.php.dist
asconfig/autoload/local.php
- optional: to run/create tests, duplicate
config/autoload/local.test.php.dist
asconfig/autoload/local.test.php
<- this creates a new in-memory database that your tests will run on
Setup database
Use an existing empty one or create a new MariaDB/MySQL database.
Recommended collation:
utf8mb4_general_ci
.
Running migrations
- fill out the database connection params in
config/autoload/local.php
under$databases['default']
- run the database migrations by using the following command:
php ./vendor/bin/doctrine-migrations migrate
This command will prompt you to confirm that you want to run it:
WARNING! You are about to execute a migration in database "
<database>
" that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
Hit Enter
to confirm the operation.
Executing fixtures
Fixtures are used to seed the database with initial values and must be executed after migrating the database.
To list all the fixtures, run:
php ./bin/doctrine fixtures:list
This will output all the fixtures in the order of execution.
To execute all fixtures, run:
php ./bin/doctrine fixtures:execute
To execute a specific fixture, run:
php ./bin/doctrine fixtures:execute --class=FixtureClassName
More details on how fixtures work can be found in dotkernel/dot-data-fixtures
documentation.
Mail configuration
If your application sends emails, you must configure an outgoing mail server under config/autoload/mail.global.php
.
Test the installation
Run the following command in your project's directory to start PHPs built-in server:
php -S 0.0.0.0:8080 -t public
Running command
composer serve
will do the same thing, but the server will time out after a couple of minutes.
Sending a GET request to the application's home page should output the following message:
{ "message": "Dotkernel API version 6" }