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

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

dotkernel / api

Maintainers

Details