- Move coverage reports to phpunit.coverage.xml.dist: a coverage driver is optional and failOnWarning would turn its absence into a failed gate. - Add a composer coverage script and document the requirement. - Exclude development-only files from the distribution archive via export-ignore. - Add a Gitea Actions workflow running composer check on PHP 8.3 and 8.4. - Add CHANGELOG.md following Keep a Changelog. - Add Packagist and CI badges to the README.
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# camelia/controllers
|
|
|
|
[](https://packagist.org/packages/camelia/controllers)
|
|
[](https://packagist.org/packages/camelia/controllers)
|
|
[](https://packagist.org/packages/camelia/controllers)
|
|
[](https://git.dr2gsistemas.duckdns.org/dr2gsistemas/camelia-controller/actions)
|
|
|
|
Framework-agnostic REST controller toolkit: routing, request parsing, validation and JSON responses
|
|
over any data source. Vanilla PHP, no framework.
|
|
|
|
- **Package:** `camelia/controllers` — **Namespace:** `Camelia\Controllers`
|
|
- **PHP** `>=8.3`, extension `json`
|
|
|
|
## What it is
|
|
|
|
The HTTP layer of a REST API, and nothing else:
|
|
|
|
- **Routing** with parameters (`/articulos/{id}`), plus 404 and 405 responses with an `Allow` header.
|
|
- **Immutable request and response** objects. Nothing is printed; a `Response` is returned and the
|
|
adapter emits it.
|
|
- **Generic CRUD** over a `ResourceGateway` port that the application implements.
|
|
- **Composable middlewares:** authentication, roles, rate limiting, CORS, logging, content
|
|
negotiation.
|
|
|
|
## What it is not
|
|
|
|
Not a framework. No dependency-injection container, no ORM, no templating. The package declares its
|
|
own ports; if an application uses an ORM, it connects it by composition.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
composer require camelia/controllers
|
|
```
|
|
|
|
## Documentation
|
|
|
|
The full developer guide, organised by task, is in
|
|
[`docs/GUIA-PROGRAMADOR.md`](docs/GUIA-PROGRAMADOR.md). The normative contract — public names, JSON
|
|
shapes and status codes — is [`docs/especificaciones-controllers.md`](docs/especificaciones-controllers.md).
|
|
|
|
The documentation index lives in [`docs/README.md`](docs/README.md).
|
|
|
|
## Development
|
|
|
|
```bash
|
|
composer install
|
|
composer check # fmt:check -> lint -> analyze -> phpstan -> test
|
|
```
|
|
|
|
`composer check` must be green before anything is merged, and the steps run in that order.
|
|
|
|
## License
|
|
|
|
MIT. See [LICENSE](LICENSE).
|