Configuration

# Customizing PHP Namespaces

namespaces:entity:"App\ECommerce\Entity"enum:"App\ECommerce\Enum"interface:"App\ECommerce\Model"

types:Thing:namespaces:class:"App\Common\Entity"# Namespace for the Thing entity (works for enumerations too)interface:"App\Schema\Model"# Namespace of the related interface

# Forcing a Field Type (Range)

types:Brand:properties:logo:{range:"ImageObject"}# Force the range of the logo property to ImageObject (can also be a URL according to Schema.org)PostalAddress:properties:addressCountry:{range:"Text"}# Force the type to Text instead of Country. It will be converted to the PHP string type.

# Forcing a Field Cardinality

types:Product:properties:sku:cardinality:"(0..1)"

# Changing the Default Cardinality

relations:defaultCardinality:"(1..*)"

# Adding a Custom Attribute or Modifying a Generated Attribute

types:Organization:properties:contactPoint:attributes:ORM\JoinTable:{name:organization_contactPoint }# Instead of organization_contact_point by defaultApiProperty:{security:"is_granted('ROLE_ADMIN')"}

uses:App\Attributes\MyAttribute:~types:Book:attributes:- ApiResource:{routePrefix:"/library"}# Add a route prefix for this resource- MyAttribute:~# Note the optional usage of a hyphen list: it allows to preserve the order of attributes

# Forcing (or Enabling) a Class Parent

types:ImageObject:parent:Thing# Force the parent to be Thing instead of CreativeWork > MediaObjectproperties:~Drug:parent:~# Enable the class hierarchy for this type

# Forcing a Class to be Abstract

types:Person:abstract:true

# Define API Platform Operations

types:Person:operations:Get:~GetCollection:routeName:get_person_collection

# Forcing a Nullable Property

Person:properties:name:{nullable:false}

<?php
/**
 * The name of the item.
 */
#[ORM\Column]
#[Assert\NotNull]
private string $name;

# Forcing a Unique Property

Person:properties:email:{unique:true}

<?php
// api/src/Entity/Person.php
namespace App\Entity;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Doctrine\ORM\Mapping as ORM;
/**
 * A person (alive, dead, undead, or fictional).
 *
 * @see https://schema.org/Person
 */
#[ORM\Entity]
#[ApiResource(types: ['https://schema.org/Person'])]
#[UniqueEntity('email')]
class Person
{
 /**
 * Email address.
 *
 * @see https://schema.org/email
 */
 #[ORM\Column]
 #[Assert\Email]
 private string $email;
 // ...
}

# Making a Property Read-Only

Person:properties:email:{writable:false}

# Making a Property Write-Only

Person:properties:email:{readable:false}

# Forcing an Embeddable Class to be Embedded

QuantitativeValue:embeddable:trueProduct:properties:weight:{range:"QuantitativeValue", embedded:true}

<?php
// api/src/Entity/Product.php
namespace App\Entity;
use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiResource;
use Doctrine\ORM\Mapping as ORM;
/**
 * Any offered product or service.
 *
 * @see https://schema.org/Product Documentation on Schema.org
 */
#[ORM\Entity]
#[ApiResource(types: ['https://schema.org/Product'])]
#[UniqueEntity('gtin13s')]
class Product
{
 /**
 * The weight of the product or person.
 *
 * @see https://schema.org/weight
 */
 #[ORM\Embedded(class: QuantitativeValue::class)]
 #[ApiProperty(iri: 'https://schema.org/weight')]
 private ?QuantitativeValue $weight = null;
 // ...
}

# Skipping Accessor Method Generation

accessorMethods:false

# Using Fluent Mutator Methods

public function setName(?string $name): self
{
 $this->name = $name;
 return $this;
}

fluentMutatorMethods:true

# Disabling the id Generator

id:generate:false

# Generating UUIDs

id:generationStrategy:uuid

# User-submitted UUIDs

id:generationStrategy:uuidwritable:true

# Generating Custom IDs

id:generationStrategy:none

# Disabling Usage of Doctrine Collections

doctrine:useCollection:false

# Changing the Field Visibility

fieldVisibility:"protected"

# Generating Assert\Type Attributes

validator:assertType:true

# Forcing Doctrine Inheritance Mapping Attribute

doctrine:inheritanceType: SINGLE_TABLE # Default:JOINEDinheritanceAttributes:CustomInheritanceAttribute:[]

# Interfaces and Doctrine Resolve Target Entity Listener

doctrine:resolveTargetEntityConfigPath:path/to/doctrine.xml

doctrine:resolveTargetEntityConfigPath:path/to/doctrine.yamlresolveTargetEntityConfigType:YAML# Supports XML & YAML

# Doctrine Resolve Target Entity Config Type

doctrine:resolveTargetEntityConfigPath:path/to/doctrine.yamlresolveTargetEntityConfigType:yaml

# Custom Schemas

vocabularies:- https://github.com/schemaorg/schemaorg/raw/main/data/releases/13.0/schemaorg-current-https.rdf- http://example.com/data/myschema.rdf# Additional types

vocabularies:- http://vocab.linkeddata.es/vgo/GameOntologyv3.owl# The URL of the vocabulary definitiontypes:Session:vocabularyNamespace:http://purl.org/net/VideoGameOntology## ...

# All Types, Resolve Types and Exclude

vocabularies:# Schema.org classes will only be generated when one of its type is used in the other vocabularies.- {uri:"https://schema.org/version/latest/schemaorg-current-https.rdf",format:null,allTypes:false,}- http://vocab.linkeddata.es/vgo/GameOntologyv3.owlallTypes:true# Generate all types by default for vocabulariesresolveTypes:true# Resolve types in other vocabulariestypes:GameEvent:exclude:true# Exclude the GameEvent type

# Checking GoodRelation Compatibility

# Author PHPDoc

author:"Kévin Dunglas <[email protected]>"

# PHP File Header

header:| /*
 * This file is part of the Ecommerce package.
 *
 * (c) Kévin Dunglas <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

# Disabling Generators and Creating Custom Ones

annotationGenerators:- ApiPlatform\SchemaGenerator\AnnotationGenerator\PhpDocAnnotationGeneratorattributeGenerators:[]

annotationGenerators:- ApiPlatform\SchemaGenerator\AnnotationGenerator\PhpDocAnnotationGeneratorattributeGenerators- Acme\Generators\MyGenerator

# Full Configuration Reference

openApi:file:null# RDF vocabulariesvocabularies:# Prototypeuri:# RDF vocabulary to useuri: ~ # Example:'https://schema.org/version/latest/schemaorg-current-https.rdf'# RDF vocabulary formatformat: null # Example:rdfxml# Generate all types for this vocabulary, even if an explicit configuration exists. If allTypes is enabled globally, it can be disabled for this particular vocabularyallTypes:null# Attributes (merged with generated attributes)attributes:[]# Namespace of the vocabulary to importvocabularyNamespace:"https://schema.org/"# Example: 'http://www.w3.org/ns/activitystreams#'# Relations configurationrelations:# OWL relation URIs containing cardinality information in the GoodRelations formaturis: # Example:'https://archive.org/services/purl/goodrelations/v1.owl'# Default:- https://archive.org/services/purl/goodrelations/v1.owl# The default cardinality to use when it cannot be extracteddefaultCardinality:(1..1)# One of "(0..1)"; "(0..*)"; "(1..1)"; "(1..*)"; "(*..0)"; "(*..1)"; "(*..*)"# Debug modedebug:false# Use old API Platform attributes (API Platform < 2.7)apiPlatformOldAttributes:false# IDs configurationid:# Automatically add an ID field to entitiesgenerate:true# The ID generation strategy to use ("none" to not let the database generate IDs).generationStrategy:auto# One of "auto"; "none"; "uuid"; "mongoid"# Is the ID writable? Only applicable if "generationStrategy" is "uuid".writable:false# Generate interfaces and use Doctrine's Resolve Target Entity featureuseInterface:false# Emit a warning if a property is not derived from GoodRelationscheckIsGoodRelations:false# A license or any text to use as header of generated filesheader: null # Example:'// (c) Kévin Dunglas <[email protected]>'# PHP namespacesnamespaces:# The global namespace's prefixprefix: null # Example:App\# The namespace of the generated entitiesentity: App\Entity # Example:App\Entity# The namespace of the generated enumerationsenum: App\Enum # Example:App\Enum# The namespace of the generated interfacesinterface: App\Model # Example:App\Model# Custom uses (for instance if you use a custom attribute)uses:# Prototypename:# Name of this usename: ~ # Example:App\Attributes\MyAttribute# The alias to use for this usealias:null# Doctrinedoctrine:# Use Doctrine's ArrayCollection instead of standard arraysuseCollection:true# The Resolve Target Entity Listener config file pathresolveTargetEntityConfigPath:null# The Resolve Target Entity Listener config file typeresolveTargetEntityConfigType:XML# One of "XML"; "yaml"# Doctrine inheritance attributes (if set, no other attributes are generated)inheritanceAttributes:[]# The inheritance type to use when an entity is referenced by another and has childinheritanceType:JOINED# One of "JOINED"; "SINGLE_TABLE"; "SINGLE_COLLECTION"; "TABLE_PER_CLASS"; "COLLECTION_PER_CLASS"; "NONE"# Maximum length of any given database identifier, like tables or column namesmaxIdentifierLength:63# Symfony Validator Componentvalidator:# Generate @Assert\Type annotationassertType:false# The value of the phpDoc's @author annotationauthor: false # Example:'Kévin Dunglas <[email protected]>'# Visibility of entities fieldsfieldVisibility:private# One of "private"; "protected"; "public"# Set this flag to false to not generate getter, setter, adder and remover methodsaccessorMethods:true# Set this flag to true to generate fluent setter, adder and remover methodsfluentMutatorMethods:falserangeMapping:# Prototypename:~# Generate all types, even if an explicit configuration existsallTypes:false# If a type is present in a vocabulary but not explicitly imported (types) or if the vocabulary is not totally imported (allTypes), it will be generatedresolveTypes:false# Types to import from the vocabularytypes:# Prototypeid:# Exclude this type, even if "allTypes" is set to true"exclude:false# Namespace of the vocabulary of this type (defaults to the global "vocabularyNamespace" entry)vocabularyNamespace: null # Example:'http://www.w3.org/ns/activitystreams#'# Is the class abstract? (null to guess)abstract:null# Is the class embeddable?embeddable:false# Type namespacesnamespaces:# The namespace for the generated class (override any other defined namespace)class:null# The namespace for the generated interface (override any other defined namespace)interface:null# Attributes (merged with generated attributes)attributes:[]# The parent class, set to false for a top level classparent:false# If declaring a custom class, this will be the class from which properties type will be guessedguessFrom:Thing# Operations for the classoperations:[]# Import all existing propertiesallProperties:false# Properties of this type to useproperties:# Prototypeid:# Exclude this property, even if "allProperties" is set to true"exclude:false# The property rangerange: null # Example:Offercardinality:unknown# One of "(0..1)"; "(0..*)"; "(1..1)"; "(1..*)"; "(*..0)"; "(*..1)"; "(*..*)"; "unknown"# Symfony Serialization Groupsgroups:[]# The doctrine mapped by attributemappedBy: null # Example:partOfSeason# The doctrine inversed by attributeinversedBy: null # Example:episodes# Is the property readable?readable:true# Is the property writable?writable:true# Is the property nullable? (if null, cardinality will be used: will be true if no cardinality found)nullable:null# Is the property required?required:true# The property uniqueunique:false# Is the property embedded?embedded:false# Attributes (merged with generated attributes)attributes:[]# Annotation generators to useannotationGenerators:# Default:- ApiPlatform\SchemaGenerator\AnnotationGenerator\PhpDocAnnotationGenerator# Attribute generators to useattributeGenerators:# Defaults:- ApiPlatform\SchemaGenerator\AttributeGenerator\DoctrineOrmAttributeGenerator- ApiPlatform\SchemaGenerator\AttributeGenerator\DoctrineOrmAssociationOverrideAttributeGenerator- ApiPlatform\SchemaGenerator\AttributeGenerator\ApiPlatformCoreAttributeGenerator- ApiPlatform\SchemaGenerator\AttributeGenerator\ConstraintAttributeGenerator- ApiPlatform\SchemaGenerator\AttributeGenerator\ConfigurationAttributeGenerator# Directories for custom generator twig templatesgeneratorTemplates:[]