PHPackages                             nelmio/api-doc-bundle - 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 &amp; Networking](/categories/http)
4. /
5. nelmio/api-doc-bundle

ActiveSymfony-bundle[HTTP &amp; Networking](/categories/http)

nelmio/api-doc-bundle
=====================

Generates documentation for your REST API from attributes

v5.10.2(1mo ago)2.3k66.1M↓34.4%900[52 issues](https://github.com/nelmio/NelmioApiDocBundle/issues)[9 PRs](https://github.com/nelmio/NelmioApiDocBundle/pulls)20MITPHPPHP &gt;=8.2CI passing

Since May 23Pushed 1w ago65 watchersCompare

[ Source](https://github.com/nelmio/NelmioApiDocBundle)[ Packagist](https://packagist.org/packages/nelmio/api-doc-bundle)[ GitHub Sponsors](https://github.com/DjordyKoert)[ RSS](/packages/nelmio-api-doc-bundle/feed)WikiDiscussions 5.x Synced 1w ago

READMEChangelog (10)Dependencies (135)Versions (215)Used By (20)

NelmioApiDocBundle
==================

[](#nelmioapidocbundle)

[![Build Status](https://camo.githubusercontent.com/50672881a52055e8bfc603963dd675f4e41575895931ffa09defe045d7ecc635/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636865636b2d72756e732f6e656c6d696f2f4e656c6d696f417069446f6342756e646c652f352e783f7374796c653d666c61742d737175617265)](https://github.com/nelmio/NelmioApiDocBundle/actions?query=workflow:CI)[![Codecov](https://camo.githubusercontent.com/f1a1c82aaf98f1045c38ac0b7fbe4cb825b470fdc2814f48262f3b117d497e51/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f6e656c6d696f2f4e656c6d696f417069446f6342756e646c652f352e783f7374796c653d666c61742d737175617265)](https://app.codecov.io/gh/nelmio/NelmioApiDocBundle/tree/5.x)[![Total Downloads](https://camo.githubusercontent.com/9628bfb6f7de19ea90bdaf9bb66b8ebbb0e5abd546305305d3c4dd675133e71d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6e656c6d696f2f6170692d646f632d62756e646c653f7374796c653d666c61742d737175617265)](https://packagist.org/packages/nelmio/api-doc-bundle)[![Latest Stable Version](https://camo.githubusercontent.com/08325a218293c6952e47222981932f399b26287ae2b1fc947485dbacbce76a81/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6e656c6d696f2f6170692d646f632d62756e646c653f6c6162656c3d737461626c65267374796c653d666c61742d737175617265)](https://packagist.org/packages/nelmio/api-doc-bundle)[![PHP Version](https://camo.githubusercontent.com/af70e446b400a2fddf5cf8fcbb07640a4b233007f4e805c86bbffd1054096070/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6e656c6d696f2f6170692d646f632d62756e646c652f5048503f7374796c653d666c61742d737175617265)](https://packagist.org/packages/nelmio/api-doc-bundle)[![License](https://camo.githubusercontent.com/bf4737eadd0e02e2770dd40d4b6791ceb0ffd1e4bdd3dd4fb497e2b6b2d09023/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e656c6d696f2f4e656c6d696f417069446f6342756e646c653f7374796c653d666c61742d737175617265)](LICENSE)

The **NelmioApiDocBundle** bundle allows you to generate a decent documentation for your APIs.

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

[](#installation)

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

```
composer require nelmio/api-doc-bundle

```

Documentation
-------------

[](#documentation)

[Read the documentation on symfony.com](https://symfony.com/doc/current/bundles/NelmioApiDocBundle/index.html)

### Migrate from 4.x to 5.0

[](#migrate-from-4x-to-50)

[To migrate from 4.x to 5.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/5.x/UPGRADE-5.0.md)

This version comes with the following major changes:

- The bundle now requires PHP 8.1 or higher.
- Support for annotations has been removed in favor of PHP 8 attributes.
- Minimum Symfony version is now 6.4.
- Major cleanup and simplification of the codebase.

### Migrate from 3.x to 4.0

[](#migrate-from-3x-to-40)

[To migrate from 3.x to 4.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/5.x/UPGRADE-4.0.md)

Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.

### Migrate from 2.x to 3.0

[](#migrate-from-2x-to-30)

[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/5.x/UPGRADE-3.0.md)

Contributing
------------

[](#contributing)

See [CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/5.x/CONTRIBUTING.md)file.

### Running the Tests

[](#running-the-tests)

Install the [Composer](http://getcomposer.org/) dependencies:

```
git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update

```

Then run the test suite:

```
composer phpunit

```

Sponsored by
------------

[](#sponsored-by)

 [ ![JetBrains logo](https://camo.githubusercontent.com/b5639e7738c6dfae9fe3f3e20175570b7376ce2577a772e09c25c2d4f14bf86e/68747470733a2f2f7265736f75726365732e6a6574627261696e732e636f6d2f73746f726167652f70726f64756374732f636f6d70616e792f6272616e642f6c6f676f732f6a6574627261696e732e737667) ](https://jb.gg/OpenSourceSupport)

 JetBrains sponsors this project by providing an open-source license for their tools.

License
-------

[](#license)

[This bundle is released under the MIT license.](LICENSE)

###  Health Score

85

—

ExcellentBetter than 100% of packages

Maintenance96

Actively maintained with recent releases

Popularity81

Widely adopted with strong download metrics

Community57

Growing community involvement

Maturity95

Battle-tested with a long release history

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~25 days

Recently: every ~11 days

Total

205

Last Release

14d ago

Major Versions

v4.38.4 → v5.8.02025-11-14

v4.38.5 → v5.8.22025-11-28

v4.38.6 → v5.8.32026-01-02

v4.38.7 → v5.9.12026-01-08

4.x-dev → v5.10.12026-05-08

PHP version history (10 changes)2.10.1PHP &gt;=5.3

2.13.1PHP &gt;=5.4

v3.0.0-BETA1PHP ~7.0|~7.1

v3.0.0PHP ^7.0

v3.6.0PHP ^7.1

v3.8.0PHP &gt;=7.1.3

v4.7.0PHP &gt;=7.2

v4.24.0PHP &gt;=7.4

v5.0.0-beta1PHP &gt;=8.1

v5.8.0PHP &gt;=8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/183678?v=4)[Jordi Boggiano](/maintainers/Seldaek)[@Seldaek](https://github.com/Seldaek)

---

Top Contributors

[![GuilhemN](https://avatars.githubusercontent.com/u/6871899?v=4)](https://github.com/GuilhemN "GuilhemN (315 commits)")[![DjordyKoert](https://avatars.githubusercontent.com/u/33036133?v=4)](https://github.com/DjordyKoert "DjordyKoert (210 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (66 commits)")[![goetas](https://avatars.githubusercontent.com/u/776743?v=4)](https://github.com/goetas "goetas (29 commits)")[![dbu](https://avatars.githubusercontent.com/u/76576?v=4)](https://github.com/dbu "dbu (24 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (23 commits)")[![chrisguitarguy](https://avatars.githubusercontent.com/u/1010392?v=4)](https://github.com/chrisguitarguy "chrisguitarguy (21 commits)")[![phansys](https://avatars.githubusercontent.com/u/1231441?v=4)](https://github.com/phansys "phansys (15 commits)")[![magnetik](https://avatars.githubusercontent.com/u/345029?v=4)](https://github.com/magnetik "magnetik (15 commits)")[![bifidokk](https://avatars.githubusercontent.com/u/425272?v=4)](https://github.com/bifidokk "bifidokk (10 commits)")[![lacatoire](https://avatars.githubusercontent.com/u/20201470?v=4)](https://github.com/lacatoire "lacatoire (10 commits)")[![zdenekdrahos](https://avatars.githubusercontent.com/u/7994022?v=4)](https://github.com/zdenekdrahos "zdenekdrahos (9 commits)")[![DominicLuidold](https://avatars.githubusercontent.com/u/22751730?v=4)](https://github.com/DominicLuidold "DominicLuidold (7 commits)")[![bobvandevijver](https://avatars.githubusercontent.com/u/1835343?v=4)](https://github.com/bobvandevijver "bobvandevijver (7 commits)")[![herndlm](https://avatars.githubusercontent.com/u/5738896?v=4)](https://github.com/herndlm "herndlm (6 commits)")[![deluxetom](https://avatars.githubusercontent.com/u/6439307?v=4)](https://github.com/deluxetom "deluxetom (6 commits)")[![derrabus](https://avatars.githubusercontent.com/u/1506493?v=4)](https://github.com/derrabus "derrabus (6 commits)")[![kopaygorodsky](https://avatars.githubusercontent.com/u/2415637?v=4)](https://github.com/kopaygorodsky "kopaygorodsky (6 commits)")[![akalineskou](https://avatars.githubusercontent.com/u/3526365?v=4)](https://github.com/akalineskou "akalineskou (5 commits)")[![javiereguiluz](https://avatars.githubusercontent.com/u/73419?v=4)](https://github.com/javiereguiluz "javiereguiluz (5 commits)")

---

Tags

apiapi-documentationbundleopenapiphpredocswaggerswagger-phpsymfonysymfony-bundleapirestdocumentationdoc

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/nelmio-api-doc-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/nelmio-api-doc-bundle/health.svg)](https://phpackages.com/packages/nelmio-api-doc-bundle)
```

###  Alternatives

[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.4M506](/packages/shopware-core)[api-platform/core

Build a fully-featured hypermedia or GraphQL API in minutes!

2.6k50.1M306](/packages/api-platform-core)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.4M195](/packages/sulu-sulu)[oro/platform

Business Application Platform (BAP)

641140.7k103](/packages/oro-platform)[shopware/platform

The Shopware e-commerce core

3.4k1.5M3](/packages/shopware-platform)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.5k5.8M710](/packages/sylius-sylius)

PHPackages © 2026

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