PHPackages                             auto1-oss/service-api-components-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. [API Development](/categories/api)
4. /
5. auto1-oss/service-api-components-bundle

ActiveAuto1-bundle[API Development](/categories/api)

auto1-oss/service-api-components-bundle
=======================================

Auto1 Common Components for Service API/Client/Handler Bundles

v1.3.1(4mo ago)586.9k↓42.5%16[1 PRs](https://github.com/auto1-oss/service-api-components-bundle/pulls)2MITPHPPHP ^7.4|^8.0CI failing

Since Feb 19Pushed 4mo ago4 watchersCompare

[ Source](https://github.com/auto1-oss/service-api-components-bundle)[ Packagist](https://packagist.org/packages/auto1-oss/service-api-components-bundle)[ RSS](/packages/auto1-oss-service-api-components-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (14)Versions (15)Used By (2)

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

[](#installation)

### config.yml

[](#configyml)

```
framework:
    serializer: { enabled: true }
    property_info: { enabled: true }
```

Example EP Provider symfony.service declaration:
------------------------------------------------

[](#example-ep-provider-symfonyservice-declaration)

### tag

[](#tag)

```
{ name: 'auto1.api.endpoint_provider', priority: 0 }
```

### services.yml

[](#servicesyml)

```
services:
    your_app.api.endpoint.provider:
        class: Auto1\ServiceAPIComponentsBundle\Service\Endpoint\EndpointProviderConfiguration
        arguments:
            - '@auto1.api.endpoint.factory'
            - '@your_app.api.endpoint_configuration.loader'
        tags:
            - { name: 'auto1.api.endpoint_provider', priority: 0 }

    your_app.api.endpoint_configuration.loader:
        class: Auto1\ServiceAPIComponentsBundle\Service\Endpoint\EndpointsConfigurationLoader
        arguments:
            - '%kernel.project_dir%/src/Resources/endpoints.yml'
```

### Super Quick Start:

[](#super-quick-start)

Only for proof of concept etc.

```
class YourProvider implements EndpointProviderInterface
{
    public function getEndpoints(): array
    {
        return [
            new EndpointImmutable(
                ...,
            ),
        ];
    }
}
```

```
services:
    your_app.api.endpoint.provider:
        class: YourProvider
        tags:
            - { name: 'auto1.api.endpoint_provider', priority: 0 }
```

Example of EP definition (yaml):
--------------------------------

[](#example-of-ep-definition-yaml)

```
# Auth
- method:        'POST'
  baseUrl:       '%wkda.java_api.url%'
  path:          '/v1/auth/oauth/token'
  requestFormat: 'url'
  requestClass:  'Auto1\ServiceDTOCollection\Authentication\OAuth\Request\PostRefreshTokenRequest'
  responseClass: 'Auto1\ServiceDTOCollection\Authentication\OAuth\Response\Token'

- method:        'GET'
  baseUrl:       '%wkda.java_api.admin_url%'
  path:          '/v1/auth/user/admin/{userUuid}/roles'
  requestFormat: 'url'
  requestClass:  'Auto1\ServiceDTOCollection\Authentication\User\Request\GetUserRolesRequest'
  responseClass: 'Auto1\ServiceDTOCollection\Authentication\User\Response\UserRoles'

# CarLead
- method:        'GET'
  baseUrl:       '%wkda.java_api.url%'
  path:          '/v1/carlead/vin/{vin}'
  requestClass:  'Auto1\ServiceDTOCollection\CarLead\CarLeadRead\Request\GetCarDetailsByVinRequest'
  responseClass: 'Auto1\ServiceDTOCollection\CarLead\CarLeadRead\Response\CarLead[]'
```

### Alternative:

[](#alternative)

```
# Auth
refreshToken:
    method:        'POST'
    baseUrl:       '%wkda.java_api.url%'
    path:          '/v1/auth/oauth/token'
    requestFormat: 'url'
    requestClass:  'Auto1\ServiceDTOCollection\Authentication\OAuth\Request\PostRefreshTokenRequest'
    responseClass: 'Auto1\ServiceDTOCollection\Authentication\OAuth\Response\Token'

getUserRoles:
    method:        'GET'
    baseUrl:       '%wkda.java_api.admin_url%'
    path:          '/v1/auth/user/admin/{userUuid}/roles'
    requestFormat: 'url'
    requestClass:  'Auto1\ServiceDTOCollection\Authentication\User\Request\GetUserRolesRequest'
    responseClass: 'Auto1\ServiceDTOCollection\Authentication\User\Response\UserRoles'

# CarLead
getCarLeadByVin:
    method:        'GET'
    baseUrl:       '%wkda.java_api.url%'
    path:          '/v1/carlead/vin/{vin}'
    requestClass:  'Auto1\ServiceDTOCollection\CarLead\CarLeadRead\Request\GetCarDetailsByVinRequest'
    responseClass: 'Auto1\ServiceDTOCollection\CarLead\CarLeadRead\Response\CarLead[]'
```

Example of ServiceRequest implementation:
-----------------------------------------

[](#example-of-servicerequest-implementation)

```
class GetCarDetailsByVinRequest implements ServiceRequestInterface
{
    private $vin;

    public function setVin(string $vin): self
    {
        $this->vin = $vin;

        return $this;
    }

    public function getVin()
    {
        return $this->vin;
    }
}
```

Url resolution
--------------

[](#url-resolution)

For altering the default behaviour of Url resolution see `UrlResolverCompilerPass` and use `auto1.api.url_resolver` tag together with `priority`:

```
    # this is a default resolver
    auto1.api.url_resolver.parameter_aware:
        class: Auto1\ServiceAPIComponentsBundle\Service\UrlResolver\ParameterAwareUrlResolver
        arguments:
            - '@service_container'
        tags:
            - { name: 'auto1.api.url_resolver', priority: 0 }
```

Debug:
------

[](#debug)

To output all registered endpoints:

```
bin/console auto1.debug.endpoints
```

###  Health Score

57

—

FairBetter than 98% of packages

Maintenance76

Regular maintenance activity

Popularity39

Limited adoption so far

Community29

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor4

4 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 ~209 days

Recently: every ~129 days

Total

13

Last Release

132d ago

PHP version history (3 changes)v1.0.0PHP &gt;=7.0.8

v1.1.0PHP &gt;=7.1.3

v1.3.0PHP ^7.4|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/454acf55975295ff3419c512f37726965bd162c36ecf96608c98276252331192?d=identicon)[dmitry-auto1](/maintainers/dmitry-auto1)

![](https://www.gravatar.com/avatar/fe489265ca53e71caf44fd3968ebe800441b20d094171c7a30b8706096fc0b91?d=identicon)[aegurtsov](/maintainers/aegurtsov)

![](https://www.gravatar.com/avatar/b8838fde794e03fccc7b390a26ae3167a0e8f44fd563f64fbbb86d45d01dc6be?d=identicon)[devops-auto1](/maintainers/devops-auto1)

---

Top Contributors

[![sklabinsky](https://avatars.githubusercontent.com/u/20512721?v=4)](https://github.com/sklabinsky "sklabinsky (5 commits)")[![milan-miscevic](https://avatars.githubusercontent.com/u/7656767?v=4)](https://github.com/milan-miscevic "milan-miscevic (2 commits)")[![alex-sun](https://avatars.githubusercontent.com/u/9051692?v=4)](https://github.com/alex-sun "alex-sun (2 commits)")[![arturkurbidaev-auto1](https://avatars.githubusercontent.com/u/115999639?v=4)](https://github.com/arturkurbidaev-auto1 "arturkurbidaev-auto1 (1 commits)")[![diego1auto](https://avatars.githubusercontent.com/u/39913169?v=4)](https://github.com/diego1auto "diego1auto (1 commits)")[![Dropaq](https://avatars.githubusercontent.com/u/3353781?v=4)](https://github.com/Dropaq "Dropaq (1 commits)")[![fpradas](https://avatars.githubusercontent.com/u/16476409?v=4)](https://github.com/fpradas "fpradas (1 commits)")[![l7ssha](https://avatars.githubusercontent.com/u/23033957?v=4)](https://github.com/l7ssha "l7ssha (1 commits)")[![pidhorodetskyi](https://avatars.githubusercontent.com/u/39693338?v=4)](https://github.com/pidhorodetskyi "pidhorodetskyi (1 commits)")[![sergeidavidenko](https://avatars.githubusercontent.com/u/112619480?v=4)](https://github.com/sergeidavidenko "sergeidavidenko (1 commits)")[![a1ryabykina](https://avatars.githubusercontent.com/u/90766875?v=4)](https://github.com/a1ryabykina "a1ryabykina (1 commits)")[![ViAuto1](https://avatars.githubusercontent.com/u/54138830?v=4)](https://github.com/ViAuto1 "ViAuto1 (1 commits)")[![adalessa](https://avatars.githubusercontent.com/u/7914601?v=4)](https://github.com/adalessa "adalessa (1 commits)")[![aivus](https://avatars.githubusercontent.com/u/1021703?v=4)](https://github.com/aivus "aivus (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/auto1-oss-service-api-components-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/auto1-oss-service-api-components-bundle/health.svg)](https://phpackages.com/packages/auto1-oss-service-api-components-bundle)
```

###  Alternatives

[sylius/sylius

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

8.4k5.6M651](/packages/sylius-sylius)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)[sulu/sulu

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

1.3k1.3M152](/packages/sulu-sulu)

PHPackages © 2026

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