Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willitscale/streetlamp
A HTTP router application wrapper.
https://github.com/willitscale/streetlamp
composer composer-package data-mapper hacktoberfest http php php82 php83 router
Last synced: 2 months ago
JSON representation
A HTTP router application wrapper.
- Host: GitHub
- URL: https://github.com/willitscale/streetlamp
- Owner: willitscale
- License: mit
- Created: 2023-01-28T00:39:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-18T23:41:23.000Z (7 months ago)
- Last Synced: 2024-09-29T20:20:53.020Z (3 months ago)
- Topics: composer, composer-package, data-mapper, hacktoberfest, http, php, php82, php83, router
- Language: PHP
- Homepage: https://packagist.org/packages/willitscale/streetlamp
- Size: 160 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streetlamp
[](https://github.com/willitscale/streetlamp/actions)
[](https://github.com/willitscale/streetlamp/blob/main/LICENSE)
[](https://packagist.org/packages/willitscale/streetlamp)
[](https://github.com/willitscale/streetlamp/commits/main)
## Table of Contents
- [1. Introduction](#1-introduction)
- [2. Prerequisites](#2-prerequisites)
- [3. Setup](#3-setup)
## 1. Introduction
Streetlamp is a simple routing library that allows you to quickly prototype APIs.
This library was built around the basic concepts of annotative routing, commonly found in Java libraries such as [JAX-RS](https://cxf.apache.org/docs/jax-rs.html) and [Spring](https://spring.io/).
Although the way it works is inspired from the aforementioned Java libraries, it has a slightly unique implementation more fitting the PHP language.
## 2. Prerequisites
To keep up with modern standards this library was built using PHP 8.2 and therefore will only run in said environment or greater.
If there is enough demand I may be willing to retrofit back to PHP 8, but as it's built with attributes it can't go back any further.
Finally, this project requires composer and the [PSR-4 Autoload standard](https://www.php-fig.org/psr/psr-4/).
## 3. Setup
### 3.1. Installing the library
Simply include Streetlamp in your project with the composer command:
```sh
composer require willitscale/streetlamp
```
### 3.2. Application Wrapper
To run your application through the Streetlamp wrapper all you need to do is instantiate the `Router` class and call `route`.
The `Router` will use a `RouteBuilder` to scan all of your namespaces in the `composer.json` (excluding test namespaces by default) and setup corresponding routes.
Here's all the code you need to get going:
```php
route();
```
This will use a simple out of the box configuration, if you require any customisation this can be achieved with the `RouterConfig`.
There's a comprehensive guide on configuration in the [Configuration page](docs/CONFIGURATION.MD).
### 3.3 Creating a Controller
A controller can be defined by simply giving a class the attribute of `RouteController`.
```php
setData('world')
->setHttpStatusCode(HttpStatusCode::HTTP_OK);
}
}
```
We could have also applied the `#[Path('/hello')]` to the `RouteController` and then all routes defined within the controller have that path prefixed to them so you would not need to apply a path to them individually.
## 4. Futher Reading
- [Routing Attributes](docs/ROUTING_ATTRIBUTES.MD)
- [Input Attributes](docs/INPUT_ATTRIBUTES.MD)
- [Data Mapping](docs/DATA_MAPPING.MD)
- [Validators](docs/VALIDATORS.MD)
- [Caching](docs/CACHING.MD)
- [Configuration](docs/CONFIGURATION.MD)
- [Setup](docs/SETUP.MD)
- [Testing](docs/TESTING.MD)
- [Error Codes](docs/ERROR_CODES.MD)
- [Commands](docs/COMMANDS.MD)
- [Performance](docs/PERFORMANCE.MD)
- [TODO](docs/TODO.MD)