This extension brings the power of Slim for applications using Nette DI. It enables you to easily work with Slim middleware stack and develop your API easily.
This package now uses Slim Framework 4.x
The general idea has been discussed in this article. (Czech language)
The main idea is to delegate responsibilities of the code handling requests to separated middlewares. For example:
- authentication
- validation
- business logic
How middlewares in Slim work is described here.
Empowered by Nette DI and it's neon configuration syntax this package provides powerful and easy way to define your API.
So let's start!
composer require brandembassy/slim-nette-extension
Now register new extension by adding this code into your config.neon:
extensions:
slimApi: BrandEmbassy\Slim\DI\SlimApiExtension # Register extension
slimApi: # Configure it
slimConfiguration:
settings:
removeDefaultHandlers: true # It's recommended to disable original error handling
# and use your own error handlers suited for needs of your app.
apiDefinitionKey: api # Your API definition will be under this key in "parameters" section. Now let's say you want to make a REST endpoint creating channels, [POST] /new-api/2.0/channels
You need to define in parameters.api section in config.neon.
Both services and middlewares must be registered services in DI Container.
slimApi:
handlers:
notFound: App\NotFoundHandler # Called when not route isn't matched by URL
notAllowed: App\NotAllowedHandler # Called when route isn't matched by method
error: App\ApiErrorHandler # Called when unhandled exception bubbles out
routes:
"2.0": # Version of your API
"channels": # Matched URL will be "your-domain.org/2.0/channels"
post:
# This is service will be invoked to handle the request
service: App\CreateChannelAction
# Here middleware stack is defined. It's evaluated from bottom to top.
middlewares:
- App\SomeOtherMiddleware # last in row
- App\UsuallyRequestDataValidationMiddleware # second in row
- App\SomeAuthMiddleware # this one is called first
beforeRouteMiddlewares:
# this is called for each route, before route middlewares
- App\SomeBeforeRouteMiddleware
afterRouteMiddlewares:
# this is called for each route, after the route middlewares
- App\SomeAfterRouteMiddleware
beforeRequestMiddlewares:
# this is called for each request, even when route does NOT exist (404 requests)
- App\SomeBeforeRequestMiddlewareYou can also reference the named service by its name.
See tests/SlimApplicationFactoryTest.php and tests/config.neon for more examples.
Now you can simply get SlimApplicationFactory class from your DI Container (or better autowire it), create app and run it.
$factory = $container->getByType(SlimApplicationFactory::class);
$app = $factory->create();
$app->run();Version 4.x of this package uses Slim Framework 4 instead of Slim Framework 3. The migration should be mostly transparent for users as the package maintains backward compatibility where possible.
- Dependencies: Slim 4 uses PSR-7, PSR-15, and PSR-17 standards more strictly
- Container: Slim 4 no longer provides its own container, but the package provides a compatibility layer
- Middleware: The double-pass middleware style (
$request, $response, $next) is still supported - Routing: Routes are now registered on the App instance directly (handled internally by the package)
For most users, the upgrade should be seamless:
- Update your
composer.jsonto require the new version - Run
composer update brandembassy/slim-nette-extension - Clear your cache directories (
temp/,tests/temp/) - Test your application
ResponseandResponseInterfacewrappers have been removed — route handlers now receive a plain PSR-7ResponseInterfacedirectlyRequestInterface::getRoute()now returns?Route(nullable)RequestInterfacegained new methods:getInnerRequest(),getRoutingResults()- If you were directly accessing Slim internals (like
Slim\ContainerorSlim\Router), you'll need to update your code - Custom middleware that relied on Slim 3 specific features may need updates
$app->run()and$app->handle()now apply a Content-Type fix for empty responses
The following are maintained for backward compatibility:
- Middleware signature remains the same (double-pass style
$request, $response, $next) - Route handler signature remains the same (
$request, $response) - Route and handler registration via NEON configuration is unchanged
- Container access via
$app->getContainer()works as before
For more details on Slim 4 changes, see the official Slim 4 upgrade guide.