PHPackages                             elenyum/open-api - 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. elenyum/open-api

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

elenyum/open-api
================

This bundle generates documentation and returns JSON formatted according to the OpenAPI specification.

1.0(1y ago)024MITPHPPHP >=8.1

Since Feb 4Pushed 1y ago1 watchersCompare

[ Source](https://github.com/app-elenyum/ElenyumOpenAPIBundle)[ Packagist](https://packagist.org/packages/elenyum/open-api)[ RSS](/packages/elenyum-open-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (10)Versions (2)Used By (0)

Elenyum Open API
================

[](#elenyum-open-api)

---

This bundle generates documentation and returns JSON formatted according to the OpenAPI specification.

Install
-------

[](#install)

```
composer require elenyum/open-api
```

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

[](#configuration)

For adding configuration, create a config file in the project root directory, /config/packages/elenyum\_open\_api.yaml. In the config file add:

```
elenyum_open_api:
    documentation:
        info:
            title: My project name
            description: My project description
            version: 1.0.0
```

To add a route to get the json specification add to project root file /config/routes/elenyum\_open\_api.yaml

width config example:

```
app.openapi:
  path: /v1/doc
  methods: GET
  defaults: { _controller: elenyum_open_api }
```

### Cache Configuration

[](#cache-configuration)

---

- **cache.enable**:
    Indicates whether caching is activated. Default: `false`.
- **cache.item\_id**:
    Sets the cache item identifier. Default: `elenyum_open_api`.

#### Example:

[](#example)

yaml

```
cache:
  enable: true
  item_id: 'my_custom_cache_id'
```

### Documentation Configuration

[](#documentation-configuration)

---

Serves as a foundation for creating API documentation using attributes as keys.

- **documentation.info.title**:
    The title of the application in the documentation: `My App`.
- **documentation.info.description**:
    The description of the application in the documentation: `Description service`.
- **documentation.info.version**:
    The version of the application in the documentation: `1.0.0`.

#### Example:

[](#example-1)

yaml

```
documentation:
  info:
    title: 'My App'
    description: 'Description service'
    version: '1.0.0'
```

### Other Configuration

[](#other-configuration)

---

Filters the routes that will be documented and manages their visibility in the generated documentation.

- **path\_patterns**:
    An array of regex patterns to match against the path for including routes.
- **host\_patterns**:
    An array of regex patterns to match against the host for including routes.
- **name\_patterns**:
    An array of regex patterns to match against the route name for including routes.
- **with\_tag**:
    A boolean indicating if routes should be filtered by tag (annotations).
- **disable\_default\_routes**:
    A boolean indicating if default routes without explicit OpenAPI annotations should be excluded.

#### Example

[](#example-2)

yaml

```
path_patterns: ['^/api']
host_patterns: ['^api\.']
name_patterns: ['^api_v1']
with_tag: true
disable_default_routes: false
```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance42

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

465d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8c87ff5822d69887fc220a47f558378be0c15fe58a21027cb0385e2672aba2c6?d=identicon)[boottaa](/maintainers/boottaa)

---

Top Contributors

[![boottaa](https://avatars.githubusercontent.com/u/11735354?v=4)](https://github.com/boottaa "boottaa (30 commits)")

---

Tags

apirestdocumentationdoc

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/elenyum-open-api/health.svg)

```
[![Health](https://phpackages.com/badges/elenyum-open-api/health.svg)](https://phpackages.com/packages/elenyum-open-api)
```

###  Alternatives

[nelmio/api-doc-bundle

Generates documentation for your REST API from attributes

2.3k63.6M233](/packages/nelmio-api-doc-bundle)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[api-platform/serializer

API Platform core Serializer

223.4M31](/packages/api-platform-serializer)

PHPackages © 2026

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