Dotkernel API is a production-ready REST API application built on the Mezzio microframework and Laminas components, which implements standards like PSR-3, PSR-4, PSR-7, PSR-11 and PSR-15.

It ships assembled rather than as a starting point: OAuth2 authorization, role-based access control, HAL responses with RFC 7807 error handling, admin and user management, mail, pagination, and a generated OpenAPI specification are wired together, tested, and maintained as a unit.

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.

Check out the full documentation available at https://docs.dotkernel.org/api-documentation/.

Branch	Release	PSR-11	OSS Lifecycle	PHP Version
7.0	>= 7.1	1
7.0	< 7.1	1
6.0	< 7.0	1
5.0	< 6.0	1
4.0	< 5.0	1
3.0	< 4.0	1

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 .

composer install

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

• duplicate config/autoload/cors.local.php.dist as config/autoload/cors.local.php <- if your API is consumed by another application, make sure configure the allowed_origins
• duplicate config/autoload/local.php.dist as config/autoload/local.php
• optional: to run/create tests, duplicate config/autoload/local.test.php.dist as config/autoload/local.test.php <- this creates a new in-memory database that your tests will run on

Use an existing empty database or create a new MariaDB/Postgres one.

Recommended collation: utf8mb4_general_ci.

With a database created, fill out the database connection params in config/autoload/local.php under $databases['default'].

Create a new migration by running:

php ./vendor/bin/doctrine-migrations diff

The new migration file will be placed in src/Core/src/App/src/Migration/.

Execute a new migration by running:

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.

Fixtures are used to seed the database with initial values and must be executed after migrating the database.

⚠️ Warning: Before running the fixtures, we strongly recommend updating the initial passwords used for the first Admin and User records, defined in:

• src/Core/src/App/src/Fixture/AdminLoader.php and
• src/Core/src/App/src/Fixture/UserLoader.php.

These fixtures ship with well-known default passwords that are unsafe to keep in any environment reachable outside your local machine.

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.

If your application sends emails, you must configure an outgoing mail server under config/autoload/mail.global.php.

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 7"
}