PHPackages laminas-api-tools/api-tools-documentation-swagger - 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-swagger ActiveLibrary[API Development](/categories/api) laminas-api-tools/api-tools-documentation-swagger ================================================= Laminas API Tools API Swagger documentation module 1.7.0(2y ago)4502.8k↓34.9%13[13 issues](https://github.com/laminas-api-tools/api-tools-documentation-swagger/issues)[1 PRs](https://github.com/laminas-api-tools/api-tools-documentation-swagger/pulls)1BSD-3-ClauseJavaScriptPHP ~8.0.0 || ~8.1.0 || ~8.2.0CI failing Since Dec 31Pushed 5mo ago10 watchersCompare [ Source](https://github.com/laminas-api-tools/api-tools-documentation-swagger)[ Packagist](https://packagist.org/packages/laminas-api-tools/api-tools-documentation-swagger)[ Docs](https://api-tools.getlaminas.org)[ Fund](https://funding.communitybridge.org/projects/laminas-project)[ RSS](/packages/laminas-api-tools-api-tools-documentation-swagger/feed)WikiDiscussions 1.8.x Synced 3d ago READMEChangelog (7)Dependencies (13)Versions (29)Used By (1) Swagger Documentation Provider for Laminas API Tools ==================================================== [](#swagger-documentation-provider-for-laminas-api-tools) [![Build Status](https://github.com/laminas-api-tools/api-tools-documentation-swagger/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/laminas-api-tools/api-tools-documentation-swagger/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 [Swagger UI](http://swagger.io/). The Swagger UI is immediately accessible after enabling this module at the URI path `/api-tools/swagger`. In addition to providing the HTML UI, this module also plugs into the main Laminas API Tools documentation resource (at the path `/api-tools/documentation`) in order to allow returning a documentation payload in the `application/vnd.swagger+json` media type; this resource is what feeds the Swagger UI. You can access this representation by passing the media type `application/vnd.swagger+json` for the `Accept` header via the path `/api-tools/documentation/:module/:service`. 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-swagger ``` Alternately, manually add the following to your `composer.json`, in the `require` section: ``` "require": { "laminas-api-tools/api-tools-documentation-swagger": "^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\Swagger', ], /* ... */ ]; ``` > ### 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-swagger as a module for you. Routes ------ [](#routes) ### /api-tools/swagger [](#api-toolsswagger) Shows the Swagger UI JavaScript application. ### Assets: `/api-tools-documentation-swagger/` [](#assets-api-tools-documentation-swagger) Various CSS, images, and JavaScript libraries required to deliver the Swagger UI client application. Configuration ------------- [](#configuration) ### System Configuration [](#system-configuration) The following is required to ensure the module works within a Laminas and/or Laminas API Tools-enabled application: ``` namespace Laminas\ApiTools\Documentation\Swagger; return [ 'router' => [ 'routes' => [ 'api-tools' => [ 'child_routes' => [ 'swagger' => [ 'type' => 'segment', 'options' => [ 'route' => '/swagger', 'defaults' => [ 'controller' => SwaggerUi::class, 'action' => 'list', ], ], 'may_terminate' => true, 'child_routes' => [ 'api' => [ 'type' => 'segment', 'options' => [ 'route' => '/:api', 'defaults' => [ 'action' => 'show', ], ], 'may_terminate' => true, ], ], ], ], ], ], ], 'service_manager' => [ 'factories' => [ SwaggerViewStrategy::class => SwaggerViewStrategyFactory::class, ], ], 'controllers' => [ 'factories' => [ SwaggerUi::class => SwaggerUiControllerFactory::class, ], ], 'view_manager' => [ 'template_path_stack' => [ 'api-tools-documentation-swagger' => __DIR__ . '/../view', ], ], 'asset_manager' => [ 'resolver_configs' => [ 'paths' => [ __DIR__ . '/../asset', ], ], ], 'api-tools-content-negotiation' => [ 'accept_whitelist' => [ 'Laminas\ApiTools\Documentation\Controller' => [ 0 => 'application/vnd.swagger+json', ], ], 'selectors' => [ 'Documentation' => [ ViewModel::class => [ 'application/vnd.swagger+json', ], ], ], ], ]; ``` Laminas Events -------------- [](#laminas-events) ### Listeners [](#listeners) #### Laminas\\ApiTools\\Documentation\\Swagger\\Module [](#laminasapitoolsdocumentationswaggermodule) This listener is attached to the `MvcEvent::EVENT_RENDER` event at priority `100`. Its purpose is to conditionally attach a view strategy to the view system in cases where the controller response is a `Laminas\ApiTools\Documentation\Swagger\ViewModel` view model (likely selected as the content-negotiated view model based off of `Accept` media types). Laminas Services ---------------- [](#laminas-services) ### View Models [](#view-models) #### Laminas\\ApiTools\\Documentation\\Swagger\\ViewModel [](#laminasapitoolsdocumentationswaggerviewmodel) This view model is responsible for translating the available `Laminas\ApiTools\Documentation` models into Swagger-specific models, and further casting them to arrays for later rendering as JSON. ### Health Score 48 — FairBetter than 93% of packages Maintenance29 Infrequent updates — may be unmaintained Popularity43 Moderate usage in the ecosystem Community28 Small or concentrated contributor base Maturity80 Battle-tested with a long release history Bus Factor1 Top contributor holds 75.8% 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 ~48 days Recently: every ~125 days Total 28 Last Release 1088d ago Major Versions 0.9.1 → 1.0.02019-12-31 PHP version history (7 changes)0.9.0PHP >=5.3.23 1.1.0PHP >=5.5 1.2.0PHP ^5.6 || ^7.0 1.4.0PHP ^7.3 1.4.1PHP ^7.3 || ~8.0.0 1.5.0PHP ^7.4 || ~8.0.0 || ~8.1.0 1.7.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 (147 commits)")[![ralphschindler](https://avatars.githubusercontent.com/u/76674?v=4)](https://github.com/ralphschindler "ralphschindler (17 commits)")[![michalbundyra](https://avatars.githubusercontent.com/u/7423207?v=4)](https://github.com/michalbundyra "michalbundyra (13 commits)")[![Ocramius](https://avatars.githubusercontent.com/u/154256?v=4)](https://github.com/Ocramius "Ocramius (3 commits)")[![laminas-bot](https://avatars.githubusercontent.com/u/68250880?v=4)](https://github.com/laminas-bot "laminas-bot (2 commits)")[![snapshotpl](https://avatars.githubusercontent.com/u/312655?v=4)](https://github.com/snapshotpl "snapshotpl (2 commits)")[![Dwarfex](https://avatars.githubusercontent.com/u/721721?v=4)](https://github.com/Dwarfex "Dwarfex (2 commits)")[![neeckeloo](https://avatars.githubusercontent.com/u/1768645?v=4)](https://github.com/neeckeloo "neeckeloo (2 commits)")[![bartbrinkman](https://avatars.githubusercontent.com/u/8309358?v=4)](https://github.com/bartbrinkman "bartbrinkman (1 commits)")[![alexdenvir](https://avatars.githubusercontent.com/u/1412074?v=4)](https://github.com/alexdenvir "alexdenvir (1 commits)")[![jguittard](https://avatars.githubusercontent.com/u/5320213?v=4)](https://github.com/jguittard "jguittard (1 commits)")[![abacaphiliac](https://avatars.githubusercontent.com/u/1656273?v=4)](https://github.com/abacaphiliac "abacaphiliac (1 commits)")[![ArnaudLigny](https://avatars.githubusercontent.com/u/80580?v=4)](https://github.com/ArnaudLigny "ArnaudLigny (1 commits)")[![tasselchof](https://avatars.githubusercontent.com/u/7921861?v=4)](https://github.com/tasselchof "tasselchof (1 commits)") --- Tags hacktoberfestlaminasdocumentationswaggermoduleapi-tools ### Code Quality TestsPHPUnit Static AnalysisPsalm Type Coverage Yes ### Embed Badge ![Health badge](/badges/laminas-api-tools-api-tools-documentation-swagger/health.svg) ``` [![Health](https://phpackages.com/badges/laminas-api-tools-api-tools-documentation-swagger/health.svg)](https://phpackages.com/packages/laminas-api-tools-api-tools-documentation-swagger) ``` ### 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 401.8M10](/packages/laminas-api-tools-api-tools)[laminas-api-tools/api-tools-admin Laminas API Tools Admin module 13851.3k5](/packages/laminas-api-tools-api-tools-admin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)