vocento/microservice-bundle

Microservice项目的基包

v5.3.0 2024-02-21 14:49 UTC

README

此包包含Vocento服务的基包以及服务的版本控制和其它资源的操作方式。

安装

要安装此包,请将其包含在您的composer.json文件中的需求部分。

composer require vocento/microservice-bundle

安装包后,您需要对其进行配置。

配置包

将包添加到config/bundles.php文件中。

<?php

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

将包配置添加到config/packages/microservice.yaml文件中

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

将包路由配置添加到config/routes/microservice.yaml文件中

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

此配置将公开三个与服务相关的端点,以便启用自动发现服务、可用版本和当前版本的方式。

服务端点

请求GET /service

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

请求GET /service/name.json

{
    "name": "microservice-name"
}

请求GET /service/versions.json

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

请求GET /service/versions/current.json

{
    "version": "v2"
}