Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brandembassy/slim-nette-extension
Nette Extension for Slim API micro-framework using middlewares.
https://github.com/brandembassy/slim-nette-extension
api middleware nette nette-di nette-framework single-action-controller slim
Last synced: about 15 hours ago
JSON representation
Nette Extension for Slim API micro-framework using middlewares.
- Host: GitHub
- URL: https://github.com/brandembassy/slim-nette-extension
- Owner: BrandEmbassy
- License: mit
- Created: 2018-03-16T09:09:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T10:21:14.000Z (3 months ago)
- Last Synced: 2024-09-23T20:03:03.124Z (1 day ago)
- Topics: api, middleware, nette, nette-di, nette-framework, single-action-controller, slim
- Language: PHP
- Homepage:
- Size: 168 KB
- Stars: 18
- Watchers: 6
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/BrandEmbassy/slim-nette-extension)
[](https://packagist.org/packages/brandembassy/slim-nette-extension)
[](https://github.com/BrandEmbassy/slim-nette-extension/releases)
# Nette Extension for integration of SLIM for API
This extension brings the power of [Slim](https://www.slimframework.com/) for applications using [Nette DI](https://github.com/nette/di). It enables you to easily work with Slim middleware stack and develop your API easily.
The general idea has been discussed in this [article](https://petrhejna.org/blog/api-chain-of-responsibility-approach). (Czech language)
## Philosophy
### Single Responsibility
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](https://www.slimframework.com/docs/v3/concepts/middleware.html).
### Easy configuration
Empowered by Nette DI and it's `neon` configuration syntax this package provides powerful and easy way to define your API.
## Usage
So let's start!
```
composer require brandembassy/slim-nette-extension
```
### Extension
Now register new extension by adding this code into your `config.neon`:
```yaml
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.
```
### First API endpoint
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.**
```yaml
parameters:
api:
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:
new-api: # This is name of your API
"2.0": # Version of your API
'/channels': # Matched URL will be "your-domain.org/new-api/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.
middleware:
- 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\SomeBeforeRequestMiddleware
beforeRequestMiddlewares:
# this is called for each request, even when route does NOT exist (404 requests)
- App\SomeBeforeRouteMiddleware tests/Dummy/BeforeRequestMiddleware.php
```
You can also reference the named service by it's name.
See `tests/SlimApplicationFactoryTest.php` and `tests/config.neon` for more examples.
### Execution
Now you can simply get `SlimApplicationFactory` class from your DI Container (or better autowire it), create app and run it.
```php
$factory = $container->getByType(SlimApplicationFactory::class);
$factory->create()->run();
```