Slim is a PHP micro-framework that helps you quickly write simple yet powerful web applications and APIs.
It's recommended that you use Composer to install Slim.
$ composer require slim/slim:^4.0
This will install Slim and all required dependencies. Slim requires PHP 7.1 or newer.
Before you can get up and running with Slim you will need to choose a PSR-7 implementation that best fits your application. A few notable ones:
- Slim-Psr7 - This is the Slim Framework PSR-7 implementation
- Nyholm/psr7 & Nyholm/psr7-server - This is the fastest, strictest and most lightweight implementation available
- Guzzle/psr7 & http-interop/http-factory-guzzle - This is the implementation used by the Guzzle Client, featuring extra functionality for stream and file handling
- zend-diactoros - This is the Zend PSR-7 implementation
Slim-Http is a set of decorators for any PSR-7 implementation that we recommend is used with Slim Framework. To install the Slim-Http library simply run the following command:
composer require slim/http
The ServerRequest
and Response
object decorators are automatically detected and applied by the internal factories. If you have installed Slim-Http and wish to turn off automatic object decoration you can use the following statements:
<?php
use Slim\Factory\AppFactory;
use Slim\Factory\ServerRequestCreatorFactory;
AppFactory::setSlimHttpDecoratorsAutomaticDetection(false);
ServerRequestCreatorFactory::setSlimHttpDecoratorsAutomaticDetection(false);
$app = AppFactory::create();
// ...
In order for auto-detection to work and enable you to use AppFactory::create()
and App::run()
without having to manually create a ServerRequest
you need to install one of the following implementations:
- Slim-Psr7 - Install using
composer require slim/psr7
- Nyholm/psr7 & Nyholm/psr7-server - Install using
composer require nyholm/psr7 nyholm/psr7-server
- Guzzle/psr7 & http-interop/http-factory-guzzle - Install using
composer require guzzlehttp/psr7 http-interop/http-factory-guzzle
- zend-diactoros - Install using
composer require zendframework/zend-diactoros
<?php
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Slim\Factory\AppFactory;
require __DIR__ . '/../vendor/autoload.php';
// Instantiate App
$app = AppFactory::create();
// Add error middleware
$app->addErrorMiddleware(true, true, true);
// Add route
$app->get('/hello/{name}', function (Request $request, Response $response, $args) {
$name = $args['name'];
$response->getBody()->write("Hello, $name");
return $response;
});
$app->run();
You may quickly test this using the built-in PHP server:
$ php -S localhost:8000
Going to http://localhost:8000/hello/world will now display "Hello, world".
For more information on how to configure your web server, see the Documentation.
To execute the test suite, you'll need to install all development dependencies.
$ git clone https://github.com/slimphp/Slim
$ composer install
$ composer test
Please see CONTRIBUTING for details.
Learn more at these links:
If you discover security related issues, please email security@slimframework.com instead of using the issue tracker.
Slim is part of Tidelift which gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.
This project exists thanks to all the people who contribute. Contribute.
Become a financial contributor and help us sustain our community. Contribute
Support this project with your organization. Your logo will show up here with a link to your website. Contribute
The Slim Framework is licensed under the MIT license. See License File for more information.