maurobonfietti/rest-api-slim-php

Example of REST API with Slim PHP micro Framework.

REST API IN SLIM PHP

This is an example of a RESTful API built using the Slim PHP micro-framework.

The API allows you to manage resources such as users, tasks, and notes.

You can also read this README IN SPANISH.

🖥️ TECHNOLOGIES USED:

The leading technologies used in this project are:

• PHP 8
• Slim 3
• MySQL
• Redis
• dotenv
• PHPUnit
• JSON Web Tokens (JWT)

Additional tools:

Also, I use other additional tools like:

• Docker & Docker Compose
• Travis CI
• Swagger
• Code Climate
• Scrutinizer
• Sonar Cloud
• PHPStan
• PHP Insights
• Heroku
• CORS

⚙️ QUICK INSTALL:

Requirements:

• Git
• Composer
• PHP >= 8.0
• MySQL/MariaDB
• Redis (Optional)
• or Docker

With Composer:

You can create a new project running the following commands:

$ composer create-project maurobonfietti/rest-api-slim-php [my-api-name]
$ cd [my-api-name]
$ composer restart-db
$ composer test
$ composer start

With Git:

In your terminal, execute these commands:

$ git clone https://github.com/maurobonfietti/rest-api-slim-php.git && cd rest-api-slim-php
$ cp .env.example .env
$ composer install
$ composer restart-db
$ composer test
$ composer start

With Docker:

You can use this project using docker and docker-compose.

Minimal Docker Version:

• Engine: 18.03+
• Compose: 1.21+

Commands:

# Start the API (this is my alias for: docker-compose up -d --build).
$ make up

# To create the database and import test data from scratch.
$ make db

# Checkout the API.
$ curl http://localhost:8081

# Stop and remove containers (it's like: docker-compose down).
$ make down

🛠️ TROUBLESHOOTING:

If you get stuck, you can try this guide step by step.

🎦 TUTORIALS:

Watch this mini-series of videos about Slim PHP (Spanish Audio 🔉 🇪🇸 🇦🇷).

📹 VIDEO #1

How to install and configure this API.

🎥 VIDEO #2

How to use JWT for Authentication.

📹 VIDEO #3

Using Redis Cache.

🎥 VIDEO #4

Deploy Slim PHP on Heroku.

📦 DEPENDENCIES:

LIST OF REQUIRE DEPENDENCIES:

• slim/slim: Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs.
• respect/validation: The most awesome validation engine ever created for PHP.
• palanik/corsslim: Cross-origin resource sharing (CORS) middleware for PHP Slim.
• vlucas/phpdotenv: Loads environment variables from .env to getenv(), $_ENV and $_SERVER automagically.
• predis/predis: Flexible and feature-complete Redis client for PHP and HHVM.
• firebase/php-jwt: A simple library to encode and decode JSON Web Tokens (JWT) in PHP.

LIST OF DEVELOPMENT DEPENDENCIES:

• phpunit/phpunit: The PHP Unit Testing framework.
• phpstan/phpstan: PHPStan - PHP Static Analysis Tool.
• pestphp/pest: Pest is an elegant PHP Testing Framework with a focus on simplicity.
• nunomaduro/phpinsights: Instant PHP quality checks from your console.
• vimeo/psalm: A static analysis tool for finding errors in PHP applications.
• rector/rector: Instant Upgrades and Instant Refactoring of any PHP 5.3+ code.

🚥 TESTING:

Run all PHPUnit tests with composer test.

$ composer test
> phpunit
PHPUnit 9.5.28 by Sebastian Bergmann and contributors.

........................................................          56 / 56 (100%)

Time: 00:00.697, Memory: 18.00 MB

OK (56 tests, 343 assertions)

SCREENSHOOTS:

---

---

📚 DOCUMENTATION:

ENDPOINTS:

INFO:

• Help: GET /

• Status: GET /status

USERS:

• Login User: POST /login

• Create User: POST /api/v1/users

• Update User: PUT /api/v1/users/{id}

• Delete User: DELETE /api/v1/users/{id}

TASKS:

• Get All Tasks: GET /api/v1/tasks

• Get One Task: GET /api/v1/tasks/{id}

• Create Task: POST /api/v1/tasks

• Update Task: PUT /api/v1/tasks/{id}

• Delete Task: DELETE /api/v1/tasks/{id}

NOTES:

• Get All Notes: GET /api/v1/notes

• Get One Note: GET /api/v1/notes/{id}

• Create Note: POST /api/v1/notes

• Update Note: PUT /api/v1/notes/{id}

• Delete Note: DELETE /api/v1/notes/{id}

Also, you can see the API documentation with the complete list of endpoints.

IMPORT WITH POSTMAN:

All the API information is prepared for download and use as Postman collection: Import Collection.

🚀 DEPLOY:

You can deploy this API with Heroku.

ℹ️ MORE INFORMATION:

For more information about this project, check out my blog post: How to create a REST API using Slim PHP.

You can also look at the to-do list web app I developed using this API in Angular.

💬 CONTRIBUTING:

If you would like to contribute to the project, please open an issue or submit a pull request. Contributions are always welcome!

❤️ DO YOU LIKE THE PROJECT?

You can support this project by inviting me a coffee ☕ 😋 or giving a star to this repo ⭐ 😎.

📄 LICENSE

The MIT License (MIT). Please see License File for more information.

rest-api-slim-php's Issues

Script extras/bin/restart-api.sh handling the database event returned with error code 1

Script extras/bin/restart-api.sh handling the database event returned with error code 1 when I run composer database

"migration" tool.

Hi,

Someone just asked for help with using this project, and looking quickly I found that the 'database migration' script actually is more of a 'nuke from orbit and recreate from a backup' script.

This is just an opinion but:

If you're going to call it a DB migration tool, then it should probably behave like phinx or Doctrine migrations.

If it's intended to drop the existing database and restore from a backup, then it shouldn't be called a migration tool.

Having the capability for a 'migration' to destroy data is highly suprising.

cheers
Dan
Ack

Invalid HTTP status code

I am getting following error eventhough passing JWT token to getalltask API.

Fatal error: Uncaught InvalidArgumentException: Invalid HTTP status code in F:\wamp64\www\testapi\vendor\slim\slim\Slim\Http\Response.php on line

Adding Port Setting

Hi,
This is an awesome job, thank you so much. In my case the mysql server isn't running on the default port, I had to tweak the code a bit to allow for an additional setting.

in .env:
DB_PORT='3308'

in extras/bin/restart-db.php:
$dsn = "mysql:host=${hostname};port=${port};charset=utf8";
$pdo = new PDO($dsn, $username, $password);

in src/app/dependencies.php:
$port = $db['port'];
$dsn = sprintf('mysql:host=%s;dbname=%s;port=%s;charset=utf8', $db['hostname'], $db['database'], $db['port']);

Thanks again for this great project.

Error en restart-db.php

No coge variables de entorno de la DB.
Fichero: extras/bin/restart-db.php
La función $container->get('settings')['db']; no está accesible.

Las funciones getenv del fichero restart-db.php no devuelven las variables de entorno.

Issue on the database > Dependencies.php file

Hola, Buenas tardes.

Intentando probar tu api veo que me da un error al ejecutar el comando > "composer database" en la linea 18 del archivo Dependencies.php.

He comentado la linea y ha funcionado a la primera podrias tomar nota o decirme si ha sido causa algo mal condigurado?

Adjunto imagenes.

Error al ejecutar "composer database"

Funciona OK luego d e comentar la linea marcada en la primera imagen.

Add ACL to use endpoints

Could you add authentication/authorizartion layer in this sample?

Install warning

Hello

I see this:

Package webmozart/path-util is abandoned, you should avoid using it. Use symfony/filesystem instead.

How to call getRouteCollector()->getRouteParser()

How can I call getRouteCollector()->getRouteParser() in a controller?

Gettin 500 error on every route with /[{id}]

Thanks for work, is is very easy to deploy with docker.
I am getting the following issue and as a beginner I need your help

Fatal error: Uncaught InvalidArgumentException: ReasonPhrase must be supplied for this code in /var/www/html/vendor/slim/slim/Slim/Http/Response.php on line 204

The strange thing is that there is a message key value for each.
It seems that it does this only for routes that contain [{id}] (GET, POST, PUT, DELETE).

I have just cloned and run the make up command.

Any idea?

Test

test....

[ERROR] could not find driver - en composer restart-db

Buenas, cuando pruebo el comando
composer restart-db

Error:
[ERROR] could not find driver

Tengo la base de datos creado en wamp server localhost:82/phpadmin

create user problem

Hi
when try create user by api using you demo, this return { "message": "The field "password" is required.", "class": "UserException", "status": "error", "code": 400 } but in postman I send param for password.

https://rest-api-slim-php.herokuapp.com/api/v1/users?name=adson.junio&[email protected]&password=Codec123

[Features] Send Mail

Hi,

i have tried to integrate this mail sender Slim3 Mailer but not working, you can integrate it?

Thanks.

slim3 -> slim4 Error on php 8.2

PHP Deprecated: Return type of Slim\Collection::offsetExists($key) should either be compatible with ArrayAccess::offsetExists(mixed $offset): bool, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice

slimphp/Slim#3234

Not work

Auto documentation

Hi,

It is possible with your API to run Swagger documentation automatically ?

Thanks !

Very good job

Auth not working

https://rest-api-slim-php.herokuapp.com/api/v1/users/
works fine, ask for token

https://rest-api-slim-php.herokuapp.com/api/v1/users
is accesible

https://rest-api-slim-php.herokuapp.com/api/v1/users/#
works too without auth