vocento/microservice-bundle

Base bundle for Microservice projects

MicroserviceBundle

This bundle contains the base for the services at Vocento and how the versioning and other resources of the service should work., _(*1)

Installation

To install the bundle, include the package as a requirement in your composer.json file., _(*2)

composer require vocento/microservice-bundle

Once the bundle is installed, you have to configure it., _(*3)

Configure the Bundle

Add the bundle to the config/bundles.php file., _(*4)

<?php

return [
    // ...
    Vocento\MicroserviceBundle\MicroserviceBundle::class => ['all' => true],
];

Add the bundle configuration to config/packages/microservice.yaml file, _(*5)

microservice:
    name: 'microservice-name'
    debug: '%kernel.debug%'
    manage_exceptions: true
    versions:
        list:
            - 'v1'
            - 'v2'
            - 'v3.1'
            - 'v3.1.4'
        current: 'v2'

Add the bundle routing configuration to config/routes/microservice.yaml file, _(*6)

microservice:
    resource: "@MicroserviceBundle/Resources/config/routing/base.yml"

This configuration will expose three endpoints related with the service in order to enable a way to auto-discover the service, the available versions and the current version., _(*7)

Service endpoints

Request GET /service, _(*8)

{
    "name": "microservice-name",
    "current": "v2",
    "versions": [
        "v1",
        "v2",
        "v3.1",
        "v3.1.4"
    ]
}

Request GET /service/name.json, _(*9)

{
    "name": "microservice-name"
}

Request GET /service/versions.json, _(*10)

{
    "current": "v2",
    "versions": [
        "v1",
        "v2",
        "v3.1",
        "v3.1.4"
    ]
}

Request GET /service/versions/current.json, _(*11)

{
    "version": "v2"
}