README

Slim is a PHP micro-framework that helps you quickly write simple yet powerful web applications and APIs.

Installation

It's recommended that you use Composer to install Slim.

$ composer require slim/slim "^3.0"

This will install Slim and all required dependencies. Slim requires PHP 5.5.0 or newer.

Usage

Create an index.php file with the following contents:

<?php

require 'vendor/autoload.php';

$app = new Slim\App();

$app->get('/hello/{name}', function ($request, $response, $args) {
    $response->write("Hello, " . $args['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.

Additional Features

• Return an object from controller into json string
• Additional arguments for middleware

$mw = function ($request, $response, $next, $arg1, $arg2) {
    $response->getBody()->write($arg1);
    $response = $next($request, $response);
    $response->getBody()->write($arg2);

    return $response;
};

$app->get('/hello/{name}', function ($request, $response, $args) {
    $response->write("Hello, " . $args['name']);
    return $response;
})->add($mw, ['first_argument', 'second_argument']);

Tests

To execute the test suite, you'll need phpunit.

$ phpunit

Contributing

Please see CONTRIBUTING for details.

Learn More

Learn more at these links:

• Website
• Documentation
• Support Forum
• Twitter
• Resources

Security

If you discover security related issues, please email security@slimframework.com instead of using the issue tracker.

Credits

• Josh Lockhart
• Andrew Smith
• Rob Allen
• Gabriel Manricks
• All Contributors

License

The Slim Framework is licensed under the MIT license. See License File for more information.