PHPackages                             fragotesac/api-tools-rest - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. fragotesac/api-tools-rest

ActiveLibrary[HTTP & Networking](/categories/http)

fragotesac/api-tools-rest
=========================

Laminas Module providing structure for RESTful resources

1.9.1(11mo ago)05.2k↓43.9%2BSD-3-ClausePHPPHP ~8.1.0 || ~8.2.0 || ~8.3.0

Since Jun 2Pushed 11mo agoCompare

[ Source](https://github.com/fragotesac/api-tools-rest)[ Packagist](https://packagist.org/packages/fragotesac/api-tools-rest)[ Docs](https://api-tools.getlaminas.org)[ RSS](/packages/fragotesac-api-tools-rest/feed)WikiDiscussions 1.9.x Synced 1mo ago

READMEChangelog (1)Dependencies (21)Versions (2)Used By (2)

Laminas REST
============

[](#laminas-rest)

[![Build Status](https://github.com/laminas-api-tools/api-tools-rest/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/laminas-api-tools/api-tools-rest/actions/workflows/continuous-integration.yml)

> ## 🇷🇺 Русским гражданам
>
> [](#-русским-гражданам)
>
> Мы, участники Laminas, родились и живем в разных странах. У многих из нас есть друзья, родственники и коллеги как в России, так и в Украине. Некоторые из нас родились в России. Некоторые из нас живут в России. У некоторых бабушки и дедушки сражались с фашистами во Второй мировой войне. Здесь никто не поддерживает фашизм.
>
> У одного из нас есть украинская родственница, которая спаслась из дома вместе с сыном. Поезд задержался из-за бомбежки на дороге впереди. У нас есть друзья, которые прячутся в бомбоубежищах. Мы с тревогой ждем весточки от них после воздушных налетов, которые беспорядочно наносят удары и попадают по больницам, школам, детским садам и домам. Мы не берем это из каких-либо СМИ. Мы наблюдаем это напрямую.
>
> Вы доверяете нам достаточно, чтоб использовать наши программы, и мы просим вас довериться нам вновь. Мы нуждаемся в помощи. Выходите и протестуйте против этой бесполезной войны. Остановите кровопролитие. Скажите "Нет войне!"
>
> ## 🇺🇸 To Citizens of Russia
>
> [](#-to-citizens-of-russia)
>
> We at Laminas come from all over the world. Many of us have friends, family and colleagues in both Russia and Ukraine. Some of us were born in Russia. Some of us currently live in Russia. Some have grandparents who fought Nazis in World War II. Nobody here supports fascism.
>
> One team member has a Ukrainian relative who fled her home with her son. The train was delayed due to bombing on the road ahead. We have friends who are hiding in bomb shelters. We anxiously follow up on them after the air raids, which indiscriminately fire at hospitals, schools, kindergartens and houses. We're not taking this from any media. These are our actual experiences.
>
> You trust us enough to use our software. We ask that you trust us to say the truth on this. We need your help. Go out and protest this unnecessary war. Stop the bloodshed. Say "stop the war!"

Introduction
------------

[](#introduction)

This module provides structure and code for quickly implementing RESTful APIs that use JSON as a transport.

It allows you to create RESTful JSON APIs that use the following standards:

- [Hypermedia Application Language](http://tools.ietf.org/html/draft-kelly-json-hal-06), aka HAL, used for creating JSON payloads with hypermedia controls.
- [Problem Details for HTTP APIs](http://tools.ietf.org/html/draft-nottingham-http-problem-06), aka API Problem, used for reporting API problems.

Requirements
------------

[](#requirements)

Please see the [composer.json](composer.json) file.

Installation
------------

[](#installation)

Run the following `composer` command:

```
$ composer require laminas-api-tools/api-tools-rest
```

Alternately, manually add the following to your `composer.json`, in the `require` section:

```
"require": {
    "laminas-api-tools/api-tools-rest": "^1.3"
}
```

And then run `composer update` to ensure the module is installed.

Finally, add the module name to your project's `config/application.config.php` under the `modules`key:

```
return [
    /* ... */
    'modules' => [
        /* ... */
        'Laminas\ApiTools\Rest',
    ],
    /* ... */
];
```

> ### laminas-component-installer
>
> [](#laminas-component-installer)
>
> If you use [laminas-component-installer](https://github.com/laminas/laminas-component-installer), that plugin will install api-tools-rest as a module for you.

Configuration
=============

[](#configuration)

### User Configuration

[](#user-configuration)

The top-level key used to configure this module is `api-tools-rest`.

#### Key: Controller Service Name

[](#key-controller-service-name)

Each key under `api-tools-rest` is a controller service name, and the value is an array with one or more of the following keys.

##### Sub-key: `collection_http_methods`

[](#sub-key-collection_http_methods)

An array of HTTP methods that are allowed when making requests to a collection.

##### Sub-key: `entity_http_methods`

[](#sub-key-entity_http_methods)

An array of HTTP methods that are allowed when making requests for entities.

##### Sub-key: `collection_name`

[](#sub-key-collection_name)

The name of the embedded property in the representation denoting the collection.

##### Sub-key: `collection_query_whitelist` (optional)

[](#sub-key-collection_query_whitelist-optional)

An array of query string arguments to whitelist for collection requests and when generating links to collections. These parameters will be passed to the resource class' `fetchAll()` method. Any of these parameters present in the request will also be used when generating links to the collection.

Examples of query string arguments you may want to whitelist include "sort", "filter", etc.

**Starting in 1.5.0**: if a input filter exists for the `GET` HTTP method, its keys will be merged with those from configuration.

##### Sub-key: `controller_class` (optional)

[](#sub-key-controller_class-optional)

An alternate controller class to use when creating the controller service; it **must** extend `Laminas\ApiTools\Rest\RestController`. Only use this if you are altering the workflow present in the `RestController`.

##### Sub-key: `identifier` (optional)

[](#sub-key-identifier-optional)

The name of event identifier for controller. It allows multiple instances of controller to react to different sets of shared events.

##### Sub-key: `resource_identifiers` (optional)

[](#sub-key-resource_identifiers-optional)

The name or an array of names of event identifier/s for resource.

##### Sub-key: `entity_class`

[](#sub-key-entity_class)

The class to be used for representing an entity. Primarily useful for introspection (for example in the Laminas API Tools Admin UI).

##### Sub-key: `route_name`

[](#sub-key-route_name)

The route name associated with this REST service. This is utilized when links need to be generated in the response.

##### Sub-key: `route_identifier_name`

[](#sub-key-route_identifier_name)

The parameter name for the identifier in the route specification.

##### Sub-key: `listener`

[](#sub-key-listener)

The resource class that will be dispatched to handle any collection or entity requests.

##### Sub-key: `page_size`

[](#sub-key-page_size)

The number of entities to return per "page" of a collection. This is only used if the collection returned is a `Laminas\Paginator\Paginator` instance or derivative.

##### Sub-key: `max_page_size` (optional)

[](#sub-key-max_page_size-optional)

The maximum number of entities to return per "page" of a collection. This is tested against the `page_size_param`. This parameter can be set to help prevent denial of service attacks against your API.

##### Sub-key: `min_page_size` (optional)

[](#sub-key-min_page_size-optional)

The minimum number of entities to return per "page" of a collection. This is tested against the `page_size_param`.

##### Sub-key: `page_size_param` (optional)

[](#sub-key-page_size_param-optional)

The name of a query string argument that will set a per-request page size. Not set by default; we recommend having additional logic to ensure a ceiling for the page size as well, to prevent denial of service attacks on your API.

#### User configuration example:

[](#user-configuration-example)

```
'AddressBook\\V1\\Rest\\Contact\\Controller' => [
    'listener' => 'AddressBook\\V1\\Rest\\Contact\\ContactResource',
    'route_name' => 'address-book.rest.contact',
    'route_identifier_name' => 'contact_id',
    'collection_name' => 'contact',
    'entity_http_methods' => [
        0 => 'GET',
        1 => 'PATCH',
        2 => 'PUT',
        3 => 'DELETE',
    ],
    'collection_http_methods' => [
        0 => 'GET',
        1 => 'POST',
    ],
    'collection_query_whitelist' => [],
    'page_size' => 25,
    'page_size_param' => null,
    'entity_class' => 'AddressBook\\V1\\Rest\\Contact\\ContactEntity',
    'collection_class' => 'AddressBook\\V1\\Rest\\Contact\\ContactCollection',
    'service_name' => 'Contact',
],
```

### System Configuration

[](#system-configuration)

The `api-tools-rest` module provides the following configuration to ensure it operates properly in a Laminas Framework application.

```
'service_manager' => [
    'invokables' => [
        'Laminas\ApiTools\Rest\RestParametersListener' => 'Laminas\ApiTools\Rest\Listener\RestParametersListener',
    ],
    'factories' => [
        'Laminas\ApiTools\Rest\OptionsListener' => 'Laminas\ApiTools\Rest\Factory\OptionsListenerFactory',
    ],
],

'controllers' => [
    'abstract_factories' => [
        'Laminas\ApiTools\Rest\Factory\RestControllerFactory',
    ],
],

'view_manager' => [
    // Enable this in your application configuration in order to get full
    // exception stack traces in your API-Problem responses.
    'display_exceptions' => false,
],
```

Laminas Events
==============

[](#laminas-events)

### Listeners

[](#listeners)

#### Laminas\\ApiTools\\Rest\\Listener\\OptionsListener

[](#laminasapitoolsrestlisteneroptionslistener)

This listener is registered to the `MvcEvent::EVENT_ROUTE` event with a priority of `-100`. It serves two purposes:

- If a request is made to either a REST entity or collection with a method they do not support, it will return a `405 Method not allowed` response, with a populated `Allow` header indicating which request methods may be used.
- For `OPTIONS` requests, it will respond with a `200 OK` response and a populated `Allow` header indicating which request methods may be used.

#### Laminas\\ApiTools\\Rest\\Listener\\RestParametersListener

[](#laminasapitoolsrestlistenerrestparameterslistener)

This listener is attached to the shared `dispatch` event at priority `100`. The listener maps query string arguments from the request to the `Resource` object composed in the `RestController`, as well as injects the `RouteMatch`.

Laminas Services
================

[](#laminas-services)

### Models

[](#models)

#### Laminas\\ApiTools\\Rest\\AbstractResourceListener

[](#laminasapitoolsrestabstractresourcelistener)

This abstract class is the base implementation of a [Resource](#laminasrestresource) listener. Since dispatching of `api-tools-rest` based REST services is event driven, a listener must be constructed to listen for events triggered from `Laminas\ApiTools\Rest\Resource` (which is called from the `RestController`). The following methods are called during `dispatch()`, depending on the HTTP method:

- `create($data)` - Triggered by a `POST` request to a resource *collection*.
- `delete($id)` - Triggered by a `DELETE` request to a resource *entity*.
- `deleteList($data)` - Triggered by a `DELETE` request to a resource *collection*.
- `fetch($id)` - Triggered by a `GET` request to a resource *entity*.
- `fetchAll($params = [])` - Triggered by a `GET` request to a resource *collection*.
- `patch($id, $data)` - Triggered by a `PATCH` request to resource *entity*.
- `patchList($data)` - Triggered by a `PATCH` request to a resource *collection*.
- `update($id, $data)` - Triggered by a `PUT` request to a resource *entity*.
- `replaceList($data)` - Triggered by a `PUT` request to a resource *collection*.

#### Laminas\\ApiTools\\Rest\\Resource

[](#laminasapitoolsrestresource)

The `Resource` object handles dispatching business logic for REST requests. It composes an `EventManager` instance in order to delegate operations to attached listeners. Additionally, it composes request information, such as the `Request`, `RouteMatch`, and `MvcEvent` objects, in order to seed the `ResourceEvent` it creates and passes to listeners when triggering events.

### Controller

[](#controller)

#### Laminas\\ApiTools\\Rest\\RestController

[](#laminasapitoolsrestrestcontroller)

This is the base controller implementation used when a controller service name matches a configured REST service. All REST services managed by `api-tools-rest` will use this controller (though separate instances of it), unless they specify a [controller\_class](#subkeycontrollerclassoptional) option. Instances are created via the `Laminas\ApiTools\Rest\Factory\RestControllerFactory` abstract factory.

The `RestController` calls the appropriate method in `Laminas\ApiTools\Rest\Resource` based on the requested HTTP method. It returns [HAL](https://github.com/laminas-api-tools/api-tools-hal) payloads on success, and [API Problem](https://github.com/laminas-api-tools/api-tools-api-problem) responses on error.

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance50

Moderate activity, may be stable

Popularity24

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 87.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

350d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1095778?v=4)[Francis Gonzales](/maintainers/FraGoTe)[@FraGoTe](https://github.com/FraGoTe)

---

Top Contributors

[![weierophinney](https://avatars.githubusercontent.com/u/25943?v=4)](https://github.com/weierophinney "weierophinney (810 commits)")[![michalbundyra](https://avatars.githubusercontent.com/u/7423207?v=4)](https://github.com/michalbundyra "michalbundyra (31 commits)")[![acabala](https://avatars.githubusercontent.com/u/530622?v=4)](https://github.com/acabala "acabala (11 commits)")[![ralphschindler](https://avatars.githubusercontent.com/u/76674?v=4)](https://github.com/ralphschindler "ralphschindler (8 commits)")[![Wilt](https://avatars.githubusercontent.com/u/2419627?v=4)](https://github.com/Wilt "Wilt (7 commits)")[![telkins](https://avatars.githubusercontent.com/u/53731?v=4)](https://github.com/telkins "telkins (6 commits)")[![MichaelGooden](https://avatars.githubusercontent.com/u/1275012?v=4)](https://github.com/MichaelGooden "MichaelGooden (5 commits)")[![neeckeloo](https://avatars.githubusercontent.com/u/1768645?v=4)](https://github.com/neeckeloo "neeckeloo (5 commits)")[![e-belair](https://avatars.githubusercontent.com/u/596562?v=4)](https://github.com/e-belair "e-belair (5 commits)")[![AxaliaN](https://avatars.githubusercontent.com/u/724353?v=4)](https://github.com/AxaliaN "AxaliaN (4 commits)")[![ppaulis](https://avatars.githubusercontent.com/u/1609503?v=4)](https://github.com/ppaulis "ppaulis (4 commits)")[![michaelmoussa](https://avatars.githubusercontent.com/u/183833?v=4)](https://github.com/michaelmoussa "michaelmoussa (3 commits)")[![TomHAnderson](https://avatars.githubusercontent.com/u/493920?v=4)](https://github.com/TomHAnderson "TomHAnderson (3 commits)")[![rnd-cosoft](https://avatars.githubusercontent.com/u/57006314?v=4)](https://github.com/rnd-cosoft "rnd-cosoft (3 commits)")[![Ocramius](https://avatars.githubusercontent.com/u/154256?v=4)](https://github.com/Ocramius "Ocramius (3 commits)")[![geerteltink](https://avatars.githubusercontent.com/u/9497586?v=4)](https://github.com/geerteltink "geerteltink (3 commits)")[![ezimuel](https://avatars.githubusercontent.com/u/475967?v=4)](https://github.com/ezimuel "ezimuel (3 commits)")[![boesing](https://avatars.githubusercontent.com/u/2189546?v=4)](https://github.com/boesing "boesing (2 commits)")[![pearson-lucas-dev](https://avatars.githubusercontent.com/u/810636?v=4)](https://github.com/pearson-lucas-dev "pearson-lucas-dev (2 commits)")[![kersysgediminas](https://avatars.githubusercontent.com/u/51697762?v=4)](https://github.com/kersysgediminas "kersysgediminas (2 commits)")

---

Tags

laminasrestmoduleapi-toolslaminas3

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Type Coverage Yes

### Embed Badge

![Health badge](/badges/fragotesac-api-tools-rest/health.svg)

```
[![Health](https://phpackages.com/badges/fragotesac-api-tools-rest/health.svg)](https://phpackages.com/packages/fragotesac-api-tools-rest)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)