Form Schema

Experimental — 6.1@dev: configuration, APIs and output may change before a stable release. Use this package in development and validate the workflows enabled in your application.

softspring/form-schema extracts JSON-schema-like metadata from Symfony forms.

This package is still in active development. Its public API, extracted schema shape, and extension points may change before the first stable release.

What It Provides

• Schema extraction from a Symfony FormInterface, form type class, or form type instance.
• Field extractors for scalar fields, compound fields, collections, choices, and buttons.
• Support for explicit json_schema and json_scheme form options.
• Basic metadata extraction from labels, help text, defaults, and Symfony validator constraints.
• A Symfony bundle that registers the extractor services and field extractor tags.

Installation

composer require softspring/form-schema:6.1.*@dev

If Symfony Flex does not register the bundle automatically, add it manually:

// config/bundles.php
return [
    Softspring\Component\FormSchema\SfsFormSchemaBundle::class => ['all' => true],
];

Basic Usage

Create a Symfony form type to describe the payload:

<?php
namespace App\Form;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\IntegerType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

final class ExampleFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('name', TextType::class)
            ->add('age', IntegerType::class, ['required' => false]);
    }
}

Inject SchemaExtractor and extract its metadata:

use App\Form\ExampleFormType;
use Softspring\Component\FormSchema\Schema\SchemaExtractor;

final class ExampleService
{
    public function __construct(private SchemaExtractor $schemaExtractor)
    {
    }

    public function schema(): array
    {
        return $this->schemaExtractor->extract(ExampleFormType::class);
    }
}

The resulting object schema includes a string name, integer age, and required: [name]. This describes the form; it does not replace submitting and validating the payload through Symfony.

You can also pass a resolved FormInterface when the form must be created with application-specific options.

Custom Field Extractors

Create a service implementing FieldSchemaExtractorInterface and tag it with softspring.form_schema.field_extractor.

Extractors are evaluated in service order. Return true from supports() only for the fields your extractor owns.