PHPackages                             fragotesac/api-tools-versioning - 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-versioning

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

fragotesac/api-tools-versioning
===============================

Laminas Module providing listeners and route prototypes for implementing API versioning

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

Since Jun 2Pushed 11mo agoCompare

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

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

Laminas Versioning
==================

[](#laminas-versioning)

[![Build Status](https://github.com/laminas-api-tools/api-tools-versioning/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/laminas-api-tools/api-tools-versioning/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)

api-tools-versioning is a Laminas module for automating service versioning through both URIs and `Accept` or `Content-Type` header media types. Information extracted from either the URI or header media type that relates to versioning will be made available in the route match object. In situations where a controller service name is utilizing a sub-namespace matching the regexp `V(\d)`, the matched controller service names will be updated with the currently matched version string.

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

[](#requirements)

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

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

[](#installation)

Run the following `composer` command:

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

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

```
"require": {
    "laminas-api-tools/api-tools-versioning": "^1.2"
}
```

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\Versioning',
    ],
    /* ... */
];
```

> ### 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-versioning as a module for you.

Configuration
-------------

[](#configuration)

### User Configuration

[](#user-configuration)

The top-level configuration key for user configuration of this module is `api-tools-versioning`.

#### Key: `content-type`

[](#key-content-type)

The `content-type` key is used for specifying an array of regular expressions that will be used in parsing both `Content-Type` and `Accept` headers for media type based versioning information. A default regular expression is provided in the implementation which should also serve as an example of what kind of regex to create for more specific parsing:

```
'#^application/vnd\.(?P[^.]+)\.v(?P\d+)\.(?P[a-zA-Z0-9_-]+)$#'
```

This rule will match the following pseudo-code route:

```
application/vnd.{api name}.v{version}(.{resource})?+json

```

All captured parts should utilize named parameters. A more specific example, with the top-level key would look like:

```
'api-tools-versioning' => [
    'content-type' => [
        '#^application/vendor\.(?Pmwop)\.v(?P\d+)\.(?Pstatus|user)$#',
    ],
],
```

#### Key: `default_version`

[](#key-default_version)

The `default_version` key provides the default version number to use in case a version is not provided by the client. `1` is the default for `default_version`.

The setting accepts one of the two following possible values:

- A PHP `integer` indicating the default version number for *all* routes.
- An associative array, where the keys are route names, and the values the default version to use with the associated route.

Full Example:

```
// Set v2 as default version for all routes
'api-tools-versioning' => [
    'default_version' => 2,
],
```

or

```
// Set default version to v2 and v3 for the users and status routes respectively
'api-tools-versioning' => [
    'default_version' => [
        'myapi.rest.users' => 2,
        'myapi.rpc.status' => 3,
    ],
],
```

#### Key: `uri`

[](#key-uri)

The `uri` key is responsible for identifying which routes need to be prepended with route matching information for URL based versioning. This key is an array of route names that is used in the Laminas `router.routes` configuration. If a particular route is a child route, the chain will happen at the top-most ancestor.

The route matching segment consists of a rule of `[/v:version]` while specifying a constraint of digits only for the version parameter.

Example:

```
'api-tools-versioning' => [
    'uri' => [
        'api',
        'status',
        'user',
    ],
],
```

### System Configuration

[](#system-configuration)

The following configuration is provided in `config/module.config.php` to enable the module to function:

```
'service_manager' => [
    'factories' => [
        \Laminas\ApiTools\Versioning\AcceptListener::class => \Laminas\ApiTools\Versioning\Factory\AcceptListenerFactory::class,
        \Laminas\ApiTools\Versioning\ContentTypeListener::class => \Laminas\ApiTools\Versioning\Factory\ContentTypeListenerFactory::class,
        \Laminas\ApiTools\Versioning\VersionListener::class => \Laminas\ServiceManager\Factory\InvokableFactory::class,
    ],
],
```

Laminas Events
--------------

[](#laminas-events)

`api-tools-versioning` provides no new events, but does provide 4 distinct listeners:

#### Laminas\\ApiTools\\Versioning\\PrototypeRouteListener

[](#laminasapitoolsversioningprototyperoutelistener)

This listener is attached to `ModuleEvent::EVENT_MERGE_CONFIG`. It is responsible for iterating the routes provided in the `api-tools-versioning.uri` configuration to look for corresponding routes in the `router.routes` configuration. When a match is detected, this listener will apply the versioning route match configuration to the route configuration.

#### Laminas\\ApiTools\\Versioning\\VersionListener

[](#laminasapitoolsversioningversionlistener)

This listener is attached to the `MvcEvent::EVENT_ROUTE` at a priority of `-41`. This listener is responsible for updating controller service names that utilize a versioned namespace naming scheme. For example, if the currently matched route provides a controller name such as `Foo\V1\Bar`, and the currently selected version through URL or media type is `4`, then the controller service name will be updated in the route matches to `Foo\V4\Bar`;

#### Laminas\\ApiTools\\Versioning\\AcceptListener

[](#laminasapitoolsversioningacceptlistener)

This listener is attached to the `MvcEvent::EVENT_ROUTE` at a priority of `-40`. This listener is responsible for parsing out information from the provided regular expressions (see the `content-type` configuration key for details) from any `Accept` header that is present in the request, and assigning that information to the route match, with the regex parameter names as keys.

#### Laminas\\ApiTools\\Versioning\\ContentTypeListener

[](#laminasapitoolsversioningcontenttypelistener)

This listener is attached to the `MvcEvent::EVENT_ROUTE` at a priority of `-40`. This listener is responsible for parsing out information from the provided regular expressions (see the `content-type` configuration key for details) from any `Content-Type` header that is present in the request, and assigning that information to the route match, with the regex parameter names as keys.

Laminas Services
----------------

[](#laminas-services)

`api-tools-versioning` provides no unique services other than those that serve the purpose of event listeners, namely:

- `Laminas\ApiTools\Versioning\VersionListener`
- `Laminas\ApiTools\Versioning\AcceptListener`
- `Laminas\ApiTools\Versioning\ContentTypeListener`

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance50

Moderate activity, may be stable

Popularity24

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 71.6% 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 (139 commits)")[![michalbundyra](https://avatars.githubusercontent.com/u/7423207?v=4)](https://github.com/michalbundyra "michalbundyra (11 commits)")[![ralphschindler](https://avatars.githubusercontent.com/u/76674?v=4)](https://github.com/ralphschindler "ralphschindler (9 commits)")[![matiasfuster](https://avatars.githubusercontent.com/u/10004100?v=4)](https://github.com/matiasfuster "matiasfuster (7 commits)")[![lukash82](https://avatars.githubusercontent.com/u/5096284?v=4)](https://github.com/lukash82 "lukash82 (4 commits)")[![Ocramius](https://avatars.githubusercontent.com/u/154256?v=4)](https://github.com/Ocramius "Ocramius (4 commits)")[![adamculp](https://avatars.githubusercontent.com/u/284451?v=4)](https://github.com/adamculp "adamculp (3 commits)")[![geerteltink](https://avatars.githubusercontent.com/u/9497586?v=4)](https://github.com/geerteltink "geerteltink (3 commits)")[![rnd-cosoft](https://avatars.githubusercontent.com/u/57006314?v=4)](https://github.com/rnd-cosoft "rnd-cosoft (3 commits)")[![snapshotpl](https://avatars.githubusercontent.com/u/312655?v=4)](https://github.com/snapshotpl "snapshotpl (2 commits)")[![superrosko](https://avatars.githubusercontent.com/u/23222142?v=4)](https://github.com/superrosko "superrosko (2 commits)")[![michaelmoussa](https://avatars.githubusercontent.com/u/183833?v=4)](https://github.com/michaelmoussa "michaelmoussa (2 commits)")[![ezimuel](https://avatars.githubusercontent.com/u/475967?v=4)](https://github.com/ezimuel "ezimuel (1 commits)")[![kersysgediminas](https://avatars.githubusercontent.com/u/51697762?v=4)](https://github.com/kersysgediminas "kersysgediminas (1 commits)")[![samsonasik](https://avatars.githubusercontent.com/u/459648?v=4)](https://github.com/samsonasik "samsonasik (1 commits)")[![kanellov](https://avatars.githubusercontent.com/u/1442736?v=4)](https://github.com/kanellov "kanellov (1 commits)")[![fabiang](https://avatars.githubusercontent.com/u/348344?v=4)](https://github.com/fabiang "fabiang (1 commits)")

---

Tags

laminasrestmoduleapi-tools

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Type Coverage Yes

### Embed Badge

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

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

###  Alternatives

[magento/community-edition

Magento 2 (Open Source)

12.1k52.1k10](/packages/magento-community-edition)[wheelpros/fitment-platform-api

Magento 2 (Open Source)

12.1k1.2k](/packages/wheelpros-fitment-platform-api)

PHPackages © 2026

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