Slim Framework is a great, simplified tool for developers looking to build REST APIs quickly and efficiently. If you are a beginner and want to enter the world of API development, Slim offers a friendly learning curve and a clear structure to get started. This tutorial will guide you step by step in creating a REST API with Slim Framework, covering everything from installation to implementation of CRUD (Create, Read, Update, Delete) functions.
What is Slim Framework?
Slim is a micro framework for PHP that allows you to write web applications and APIs in a simple and direct way. It is perfect for small to medium-sized projects, and its structural simplicity helps developers understand and manage code effectively.
Initial setup
Previous requirements
Before you begin, make sure you have PHP and Composer installed on your system. Composer is a dependency manager for PHP that will make it easy to install Slim and other necessary libraries.
Installing Slim Framework
To get started, create a new directory for your project and navigate to it in your terminal. Run the following command to install Slim Framework along with a basic skeleton that will serve as a starting point:
composer create-project slim/slim-skeleton your-apiThis command sets up a new project called your-api and install all the necessary dependencies.
Directory Structure
Once installed, your project will have the following directory structure:
src/: Contains the source code files.vendor/: Directory where Composer installs the libraries.public/: Public folder where the file is locatedindex.phpwhich acts as the entry point of the application.logs/: To store the application logs.templates/: Directory for templates, in case your API serves HTML.
Environment Configuration
Configure your development environment to point to the directory public/. This will ensure that all requests are directed to the file index.php.
Creating the REST API
Definition of Routes
In Slim, routes are defined in the file src/routes.php. This is where we will specify our API endpoints. For example, for an API that manages "users", you could have routes like this:
$app->get('/users', AppControllerUserController::class . ':getUsers'); $app->get('/users/{id}', AppControllerUserController::class . ':getUser'); $app->post('/users', AppControllerUserController::class . ':addUser'); $app->put('/users/{id}', AppControllerUserController::class . ':updateUser'); $app->delete('/users/{id}', AppControllerUserController::class . ':deleteUser');Implementation of CRUD Functionalities
Create (POST)
To add a new user, your method in UserController could look like this:
public function addUser(Request $request, Response $response, array $args): Response { $data = $request->getParsedBody(); // Logic to add user // We respond with the added user and code 201 return $response->withJson($data, 201); }Read (GET)
To get all users or a specific user by ID:
public function getUsers(Request $request, Response $response, array $args): Response { // Logic to get users return $response->withJson(1TP4YourUsers); } public function getUser(Request $request, Response $response, array $args): Response { $id = $args['id']; // Logic to get a specific user return $hresponse->withJson(1TP4YourUsuario); }Update (PUT) and Delete (DELETE)
Similar to the previous ones, it implements the corresponding logic in the methods updateUser y deleteUser.
Testing and Debugging
To test your API, you can use tools like Postman or cURL. Testing is essential to ensure that all endpoints are working correctly and handling errors appropriately.
Conclusion
Creating a REST API with Slim Framework can be a great way to learn about backend development in a practical and direct way. With its simple architecture and powerful routing system, Slim is ideal for small and medium-sized projects and for developers just starting out in the world of APIs. Visit NelkoDev for more resources or if you need contact me, don't hesitate to do it.
English 
Spanish