PHPackages                             laminas-api-tools/api-tools-documentation-apiblueprint - 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. [API Development](/categories/api)
4. /
5. laminas-api-tools/api-tools-documentation-apiblueprint

ActiveLibrary[API Development](/categories/api)

laminas-api-tools/api-tools-documentation-apiblueprint
======================================================

Laminas API Tools API Blueprint Documentation Module

1.6.0(2y ago)323.2k↑466.7%5[1 PRs](https://github.com/laminas-api-tools/api-tools-documentation-apiblueprint/pulls)BSD-3-ClausePHPPHP ~8.0.0 || ~8.1.0 || ~8.2.0CI failing

Since Dec 31Pushed 4mo ago9 watchersCompare

[ Source](https://github.com/laminas-api-tools/api-tools-documentation-apiblueprint)[ Packagist](https://packagist.org/packages/laminas-api-tools/api-tools-documentation-apiblueprint)[ Docs](https://api-tools.getlaminas.org)[ Fund](https://funding.communitybridge.org/projects/laminas-project)[ RSS](/packages/laminas-api-tools-api-tools-documentation-apiblueprint/feed)WikiDiscussions 1.7.x Synced 3w ago

READMEChangelog (4)Dependencies (11)Versions (17)Used By (0)

API Blueprint Documentation Provider for Laminas API Tools
==========================================================

[](#api-blueprint-documentation-provider-for-laminas-api-tools)

[![Build Status](https://github.com/laminas-api-tools/api-tools-documentation-apiblueprint/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/laminas-api-tools/api-tools-documentation-apiblueprint/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 Laminas API Tools the ability to show API documentation through a [Apiary](https://apiary.io/) documentation.

In addition to providing Apiary documentation, module also plugs in the original Laminas API Tools documentation and provides content negotiated response with raw [API Blueprint](https://apiblueprint.org).

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

[](#requirements)

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

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

[](#installation)

Run the following `composer` command:

```
$ composer require laminas-api-tools/api-tools-documentation-apiblueprint
```

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

```
"require": {
    "laminas-api-tools/api-tools-documentation-apiblueprint": "^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\Documentation\ApiBlueprint',
    .,
    /* ... */
.;
```

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

Usage
-----

[](#usage)

Apiary documentation can be found on `/api-tools/blueprint/:api` uri and is accessible from the Laminas API Tools welcome page.

Querying API Blueprint
----------------------

[](#querying-api-blueprint)

When raw API Blueprint is needed, request can be done via content negotiation. Target uri is `/api-tools/blueprint/:api` and Accept header is `text/vnd.apiblueprint+markdown`.

To learn more about API Blueprint language, please check its [specification](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md).

###  Health Score

49

—

FairBetter than 94% of packages

Maintenance50

Moderate activity, may be stable

Popularity32

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity78

Established project with proven stability

 Bus Factor1

Top contributor holds 77% 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 ~92 days

Recently: every ~126 days

Total

15

Last Release

1079d ago

PHP version history (6 changes)1.0.0PHP >=5.3.23

1.1.0PHP >=5.5

1.2.0PHP ^5.6 || ^7.0

1.4.0PHP ^7.3 || ~8.0.0

1.5.0PHP ^7.3 || ~8.0.0 || ~8.1.0

1.6.0PHP ~8.0.0 || ~8.1.0 || ~8.2.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/25943?v=4)[Matthew Weier O'Phinney](/maintainers/weierophinney)[@weierophinney](https://github.com/weierophinney)

![](https://avatars.githubusercontent.com/u/296074?v=4)[Zend Framework](/maintainers/zendframework)[@zendframework](https://github.com/zendframework)

---

Top Contributors

[![weierophinney](https://avatars.githubusercontent.com/u/25943?v=4)](https://github.com/weierophinney "weierophinney (87 commits)")[![michalbundyra](https://avatars.githubusercontent.com/u/7423207?v=4)](https://github.com/michalbundyra "michalbundyra (17 commits)")[![geerteltink](https://avatars.githubusercontent.com/u/9497586?v=4)](https://github.com/geerteltink "geerteltink (3 commits)")[![Ocramius](https://avatars.githubusercontent.com/u/154256?v=4)](https://github.com/Ocramius "Ocramius (2 commits)")[![snapshotpl](https://avatars.githubusercontent.com/u/312655?v=4)](https://github.com/snapshotpl "snapshotpl (2 commits)")[![alexdenvir](https://avatars.githubusercontent.com/u/1412074?v=4)](https://github.com/alexdenvir "alexdenvir (1 commits)")[![BreiteSeite](https://avatars.githubusercontent.com/u/2171105?v=4)](https://github.com/BreiteSeite "BreiteSeite (1 commits)")

---

Tags

hacktoberfestlaminasdocumentationmoduleapi-toolsAPI Blueprintapiary

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Type Coverage Yes

### Embed Badge

![Health badge](/badges/laminas-api-tools-api-tools-documentation-apiblueprint/health.svg)

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

###  Alternatives

[wheelpros/fitment-platform-api

Magento 2 (Open Source)

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

Laminas API Tools module for Laminas

371.8M10](/packages/laminas-api-tools-api-tools)[laminas-api-tools/api-tools-admin

Laminas API Tools Admin module

13832.9k5](/packages/laminas-api-tools-api-tools-admin)

PHPackages © 2026

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