Useful skeleton for RESTful API development, using Slim PHP micro framework.
Used technologies: PHP 8, Slim 4, MySQL, PHPUnit, dotenv, Docker & Docker Compose
.
- Composer.
- PHP >= 8.1
- MySQL/MariaDB.
- or Docker.
You can create a new project running the following commands:
composer create-project maurobonfietti/slim4-api-skeleton [my-api-name]
cd [my-api-name]
composer test
composer start
By default, the API use a MySQL Database.
You should check and edit this configuration in your .env
file:
DB_HOST='127.0.0.1'
DB_NAME='yourMySqlDatabase'
DB_USER='yourMySqlUsername'
DB_PASS='yourMySqlPassword'
DB_PORT='3306'
If you like Docker, you can use this project with docker and docker-compose.
Minimal Docker Version:
- Engine: 18.03+
- Compose: 1.21+
Docker Commands:
# Create and start containers for the API.
docker-compose up -d --build
# Checkout the API.
curl http://localhost:8081
# Stop and remove containers.
docker-compose down
- slim/slim: Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs.
- slim/psr7: PSR-7 implementation for use with Slim 4.
- pimple/pimple: A small PHP dependency injection container.
- vlucas/phpdotenv: Loads environment variables from
.env
togetenv()
,$_ENV
and$_SERVER
automagically.
- phpunit/phpunit: The PHP Unit Testing framework.
- symfony/console: The Console component eases the creation of beautiful and testable command line interfaces.
- nunomaduro/phpinsights: Instant PHP quality checks from your console.
- maurobonfietti/slim4-api-skeleton-crud-generator: CRUD Generator for Slim 4 - Api Skeleton.
-
Hello:
GET /
-
Health Check:
GET /status
Develop a RESTful API with PHP and Slim 4. [:movie_camera: :sound: :es: :argentina:]
Desarrollar.una.API.RESTful.con.PHP.y.Slim.4.mp4
You can support this project inviting me a coffee โ ๐ or giving a star to this repo โญ ๐.
Now go build a cool RESTful API.