Flow PHP

OpenAPIConverter

FinalYes

Tags

example

Basic Flow to OpenAPI conversion

$schema = schema(
    int_schema('id', false),
    str_schema('name', true)
);
$openApi = $converter->toOpenAPI($schema);

Basic OpenAPI to Flow conversion

$openApiSpec = [
    'type' => 'object',
    'properties' => [
        'id' => ['type' => 'integer', 'nullable' => false],
        'name' => ['type' => 'string', 'nullable' => true]
    ]
];
$schema = $converter->fromOpenAPI($openApiSpec);

Methods

fromOpenAPI() : Schema
toOpenAPI() : array<string, mixed>

fromOpenAPI()


    public
                    fromOpenAPI(array<string, mixed> $openApiSpec) : Schema

Parameters

$openApiSpec : array<string, mixed>: OpenAPI object specification with 'type' and 'properties'

Return values

Schema

toOpenAPI()


    public
                    toOpenAPI(Schema $schema) : array<string, mixed>

Parameters

$schema : Schema: Flow schema containing field definitions

Return values

array<string, mixed> —

OpenAPI object specification with 'type' and 'properties'