Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joseluisq/ruta
A lightweight HTTP routing library for PHP 8+ without external dependencies. (WIP)
https://github.com/joseluisq/ruta
http http-router php php-library php8 routing
Last synced: 3 months ago
JSON representation
A lightweight HTTP routing library for PHP 8+ without external dependencies. (WIP)
- Host: GitHub
- URL: https://github.com/joseluisq/ruta
- Owner: joseluisq
- License: apache-2.0
- Created: 2021-05-06T15:32:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-26T22:58:01.000Z (about 1 year ago)
- Last Synced: 2024-10-21T16:45:50.968Z (3 months ago)
- Topics: http, http-router, php, php-library, php8, routing
- Language: PHP
- Homepage:
- Size: 144 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Ruta
[](https://github.com/joseluisq/ruta/actions/workflows/tests.yml) [](https://packagist.org/packages/joseluisq/ruta) [](//packagist.org/packages/joseluisq/ruta) [](https://packagist.org/packages/joseluisq/ruta) [](https://packagist.org/packages/joseluisq/ruta)
> A lightweight HTTP routing library for PHP. (WIP)
## Features
- [x] HTTP status codes
- [x] HTTP Methods
- [x] HTTP Headers
- [x] **HTTP Requests**
- [x] Handle `multipart/form-data` request data
- [x] Handle `x-www-form-urlencoded` request data
- [x] Handle `application/xml` request data
- [x] Handle `application/json` request data
- [x] Handle `query` URI request params
- [x] Access request `path` and `headers`
- [x] **HTTP Responses**
- [x] HTML, JSON, XML or Text responses
- [x] HTTP redirections
- [x] **HTTP Routing**
- [x] Routes with placeholder arguments: `/abc/{some}`
- [x] Handle multiple valid HTTP methods
- [x] Handle any valid HTTP method
- [x] Handle not match routes (404s)
- [x] Support callback or class/method style
- [x] Optional and order-insensitive arguments on callback or class/method handlers
- [x] Regular expressions support: `/abc/regex(id=^[0-9]+$)`
- [ ] Optional route arguments: `/abc/{some?}`
- [ ] Fallback routes
- [ ] Route's cache
- [x] **Middlewares**
- [x] Inspect or filter valid requests before routing
- [ ] Inspect or filter valid requests after routing
See [Leap](https://github.com/joseluisq/leap) micro-framework based on Ruta.
## Requirements
[PHP 8.0](https://www.php.net/releases/8.0/en.php) or newer.
## Install
Install via [Composer](https://packagist.org/packages/joseluisq/ruta)
```sh
composer require joseluisq/ruta:dev-master
```
## Usage
```php
json([
'host' => $req->header(Header::Host),
'headers' => $req->headers(),
]);
});
Ruta::get('/home/hola/redirect', function (Response $res) {
$res->redirect('/home/aaa/some/bbb');
});
Ruta::get('/reg/regex(id=^[0-9]+$)/exp', function (Response $res, array $args) {
$res->json(['args' => $args]);
});
Ruta::post('/home/{path3}/some2', function (Response $res) {
$res->json(['post_data' => 11010101010]);
});
Ruta::some('/home/some', [Method::POST, Method::PUT], function (Request $req, Response $res) {
$res->json(['only' => $req->method()]);
});
Ruta::any('/home/methods', function (Request $req, Response $res) {
$res->json(['method' => $req->method()]);
});
Ruta::post('/home/{path}', function (Response $res) {
$res
->header('X-Header-One', 'Header Value 1')
->header('X-Header-Two', 'Header Value 2')
->json(['some_data' => 223424234]);
});
// 2. class/method style
class HomeCtrl
{
public function index(Request $req, Response $res, array $args)
{
// 2.1 $args contains route placeholder values
if (array_key_exists('path1', $args)) {
// do something...
}
// 2.2. Get data provided via `multipart/form-data`
$data = $req->multipart();
// 2.3. Get all headers
$data = $req->headers();
// 2.4. Get a single header
$data = $req->header("Host");
// 2.5. Get data provided via `application/x-www-form-urlencoded`
$data = $req->urlencoded();
// 2.6. Get data provided via `application/json`
$data = $req->json();
// 2.7. Get data provided via `application/xml`
$data = $req->xml();
// 2.8. Get query data
$data = $req->query();
$res->json(['data' => 'Message from a class!']);
}
// Custom 404 reply
public function not_found(Response $res)
{
$res
->status(Status::NotFound)
->text("404 - Page Not Found!");
}
}
Ruta::get('/home/{path1}/some/{path2}', [HomeCtrl::class, 'index']);
// 3. Handle 404 not found routes
Ruta::not_found([HomeCtrl::class, 'not_found']);
```
## Code example
File: [example/nginx/public/index.php](example/nginx/public/index.php)
```sh
# Or run example using Docker + Nginx server
make compose-up
```
```sh
# Run example using the PHP built-in server
make container-dev
```
Now navigate for example to [http://localhost:8088/home/hola](http://localhost:8088/home/hola)
## Contributions
Feel free to send a [pull request](https://github.com/joseluisq/ruta/pulls) or file some [issue](https://github.com/joseluisq/ruta/issues).
## Contributions
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.
Feel free to send some [Pull request](https://github.com/joseluisq/ruta/pulls) or [issue](https://github.com/joseluisq/ruta/issues).
## License
This work is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE).
© 2021-present [Jose Quintana](https://git.io/joseluisq)