在Api平台/OpenApi中使用本机枚举

Question

我正在学习带有 Api-Platform 的 OpenApi/Swagger API。我创建了一个新的endpoint，它接受枚举的值作为参数：

#[ApiResource(
itemOperations: [
    'get_by_name' => [
        'openapi_context' => [
            ....
            'parameters' => [
                [
                    'in' => 'header',
                    'name' => 'X-Server-Region',
                    'schema' => [
                    'type' => 'string',
                    'enum' => ['server1', 'server2'],
                    'example' => 'server1',
                 ],
                 'description' => 'Server to select',
                 'required' => true
             ],
...
)]

然而，这是一个相当常见的参数，值可以频繁更新（随着服务器的增加），我想使用某种模板。

所以我试着:

<?php

namespace App\Enum;

enum Server: string
{
    case SERVER1 = 'server1';
    case SERVER2 = 'server2';
    ...
}

跟

'enum' => [...Server::cases()],

或者

'enum' => [Server::class],

以及其他各种形式，都无济于事。

我试图理解组件的概念，但无法找到在Symfony/Api平台中使用它们的方法。

如何在不同的endpoint重用枚举？

Answer 1

要在 Enum 支持可用之前暂时解决问题，您可以创建一个包含数据原型的类，以便在 API 中重用它。这样，您可以重复使用相同的数据集，而无需复制它。这将使您将来的工作更轻松。

所以你创建了一个数据的原型，像这样:

    class  Server
    {
        public const  PROTOTYPE = [ 'select1', 'select2', 'select3'];
    }

导入类，然后在注释中调用它，如下所示:

'enum' => Server::PROTOTYPE,

Answer 2

枚举对于PHP来说是相当新的，Api平台还没有直接支持它们。

支持将会到来，但目前您必须在配置上手动明确列出每种情况。

虽然您也可以将“cases”列表存储在类的常量中(您甚至可以在< code>enum本身中执行此操作):

enum Server : string {
   const CASES = ['server1', 'server2']
   case SERVER1 = 'server1';
   case SERVER2 = 'server2';
}

然后在注释或属性中直接使用该常量:

parameters' => [
                [
                    'in' => 'header',
                    'name' => 'X-Server-Region',
                    'schema' => [
                    'type' => 'string',
                    'enum' => Server::CASES,
                    'example' => 'server1',
                 ],
                 'description' => 'Server to select',
                 'required' => true
             ],

...这并没有真正利用enum的优势，因为您仍然需要在两个地方编辑案例，而不仅仅是一个地方；并且仅对注释或属性是方便的。如果您对API资源使用XML或YAML配置，那就没那么好了。