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
This will install Slim and all required dependencies. Slim requires PHP 7.4 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
- httpsoft/http-message & httpsoft/http-server-request - This is the fastest, strictest and most lightweight implementation available
- Nyholm/psr7 & Nyholm/psr7-server - Performance is almost the same as the HttpSoft implementation
- Guzzle/psr7 - This is the implementation used by the Guzzle Client, featuring extra functionality for stream and file handling
- laminas-diactoros - This is the Laminas (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 then 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
- httpsoft/http-message & httpsoft/http-server-request - Install using:
composer require httpsoft/http-message httpsoft/http-server-request
- Nyholm/psr7 & Nyholm/psr7-server - Install using
composer require nyholm/psr7 nyholm/psr7-server
- Guzzle/psr7 - Install using
composer require guzzlehttp/psr7
- laminas-diactoros - Install using
composer require laminas/laminas-diactoros
Then create file public/index.php.
<?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 routes
$app->get('/', function (Request $request, Response $response) {
$response->getBody()->write('<a href="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/hello/world">Try /hello/world</a>');
return $response;
});
$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 -t public
Going to https://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 [email protected] instead of using the issue tracker.
Available as part of the Tidelift Subscription.
The maintainers of Slim
and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
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.