PHPackages                             valantic/pimcore-api-documentation - 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. valantic/pimcore-api-documentation

ActiveLibrary[API Development](/categories/api)

valantic/pimcore-api-documentation
==================================

Auto generate API documentation for routes

0.6.6(8mo ago)15.5k↑92.9%1[1 issues](https://github.com/valantic/pimcore-api-documentation/issues)[7 PRs](https://github.com/valantic/pimcore-api-documentation/pulls)MITPHPPHP ^8.2CI passing

Since Oct 12Pushed 1w ago7 watchersCompare

[ Source](https://github.com/valantic/pimcore-api-documentation)[ Packagist](https://packagist.org/packages/valantic/pimcore-api-documentation)[ Docs](https://github.com/valantic/pimcore-api-documentation)[ RSS](/packages/valantic-pimcore-api-documentation/feed)WikiDiscussions main Synced 2d ago

READMEChangelogDependencies (11)Versions (37)Used By (0)

Pimcore API documentation bundle
================================

[](#pimcore-api-documentation-bundle)

[![Latest Version on Packagist](https://camo.githubusercontent.com/689f6cea6073550a3b7f53feef174d4b527ee6c5bf27bca1d69db58d99b34418/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f76616c616e7469632f70696d636f72652d6170692d646f63756d656e746174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/valantic/pimcore-api-documentation)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![PHP Checks](https://github.com/valantic/pimcore-api-documentation/actions/workflows/phpstan.yml/badge.svg)](https://github.com/valantic/pimcore-api-documentation/actions/workflows/phpstan.yml)

This package is developed by [valantic CEC Schweiz](https://www.valantic.com/en/services/digital-business/) and is under active development.

Bundle is used for generating API documentation based on API controllers.

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

[](#requirements)

- Pimcore >= 11.0.0

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

[](#installation)

1. `composer require valantic/pimcore-api-documentation`
2. Add `ValanticPimcoreApiDocumentationBundle` to `config/bundles.php`

Usage
-----

[](#usage)

```
class ProductController implements \Valantic\PimcoreApiDocumentationBundle\Http\Controller\ApiControllerInterface
{
    use \Valantic\PimcoreApiDocumentationBundle\Controller\ApiControllerTrait;

    #[Route(path: '/product', name: 'rest_api_product_create', methods: Request::METHOD_POST)]
    public function create(ProductCreateRequest $request): ProductCreateResponse|\Valantic\PimcoreApiDocumentationBundle\Http\Response\BadRequestResponse
    {
        $errors = $this->validateRequest($request);

        if (count($errors) !== 0) {
            return new \Valantic\PimcoreApiDocumentationBundle\Http\Response\BadRequestResponse($errors);
        }

        return new ProductCreateResponse(/* ... */);
    }
}

use Symfony\Component\Validator\Constraints as Assert;

class ProductCreateRequest implements \Valantic\PimcoreApiDocumentationBundle\Http\Request\Contracts\HasJsonPayload
{
    #[Assert\NotBlank]
    public ?string $name = null;

    #[Assert\NotBlank]
    public ?string $description = null;
}

class ProductCreateResponse implements \Valantic\PimcoreApiDocumentationBundle\Http\Response\ApiResponseInterface
{
    public static function status(): int
    {
        return \Symfony\Component\HttpFoundation\Response::HTTP_CREATED;
    }

    public static function getDtoClass(): string|false
    {
        return ProductCreateDto::class;
    }
}

class ProductCreateDto
{
    public function __construct(
        public ?int $id,
    ) {}
}
```

License
-------

[](#license)

In order to comply with [Pimcore's updated licensing policy](https://pimcore.com/en/resources/blog/breaking-free-pimcore-says-goodbye-to-gpl-and-enters-a-new-era-with-pocl), this bundle is (now) published under the GPLv3 license for compatibility Pimcore Platform Version 2024.4 and will be re-licensed under the POCL license as soon as it is compatible with Pimcore Platform Version 2025.1.

If you have any questiosn regarding licensing, please reach out to us at .

###  Health Score

42

—

FairBetter than 88% of packages

Maintenance61

Regular maintenance activity

Popularity24

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 78.3% 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 ~32 days

Recently: every ~132 days

Total

24

Last Release

261d ago

PHP version history (2 changes)0.1.0PHP ^8.1

0.1.4PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/a3a9e5990473e99aef1f4761575d704a5b6ea68d6eec54dadf72e6d4ff2e86c8?d=identicon)[php-cx-mountains](/maintainers/php-cx-mountains)

---

Top Contributors

[![limenet](https://avatars.githubusercontent.com/u/474329?v=4)](https://github.com/limenet "limenet (72 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (14 commits)")[![dturopoli](https://avatars.githubusercontent.com/u/35298078?v=4)](https://github.com/dturopoli "dturopoli (4 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")[![pryserv](https://avatars.githubusercontent.com/u/272573174?v=4)](https://github.com/pryserv "pryserv (1 commits)")

###  Code Quality

Static AnalysisPHPStan, Rector

Type Coverage Yes

### Embed Badge

![Health badge](/badges/valantic-pimcore-api-documentation/health.svg)

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

###  Alternatives

[dedoc/scramble

Automatic generation of API documentation for Laravel applications.

2.1k11.2M100](/packages/dedoc-scramble)[zircote/swagger-php

Generate interactive documentation for your RESTful API using PHP attributes (preferred) or PHPDoc annotations

5.3k144.5M605](/packages/zircote-swagger-php)[andreaselia/laravel-api-to-postman

Generate a Postman collection automatically from your Laravel API

1.0k644.5k4](/packages/andreaselia-laravel-api-to-postman)[kimai/kimai

Kimai - Time Tracking

4.8k9.0k1](/packages/kimai-kimai)[pimcore/data-hub

Pimcore Datahub

1361.4M12](/packages/pimcore-data-hub)[dereuromark/cakephp-ide-helper

CakePHP IdeHelper Plugin to improve auto-completion

1882.3M44](/packages/dereuromark-cakephp-ide-helper)

PHPackages © 2026

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