References
SchemaFactoryInterface
September 19-20, 2024 | Lille & online
The international conference on the API Platform Framework
API Platform Conference 2024: meet the best PHP, JavaScript and API experts
Learn more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.
Register nowReference
I
InterfaceApiPlatform\JsonSchema\SchemaFactoryInterface
Factory for creating the JSON Schema document corresponding to a PHP class.
interface ApiPlatform\JsonSchema\SchemaFactoryInterface
{
public buildSchema(string $className, string $format, string $type, null|$operation, null|`<a href="/docs/references/JsonSchema/Schema">ApiPlatform\JsonSchema\Schema</a>` $schema, null|array $serializerContext, bool $forceCollection): `<a href="/docs/references/JsonSchema/Schema">ApiPlatform\JsonSchema\Schema
}Methods
buildSchema
Builds the JSON Schema document corresponding to the given PHP class.
public buildSchema(string $className, string $format, string $type, null|$operation, null|`<a href="/docs/references/JsonSchema/Schema">ApiPlatform\JsonSchema\Schema</a>` $schema, null|array $serializerContext, bool $forceCollection): `<a href="/docs/references/JsonSchema/Schema">ApiPlatform\JsonSchema\SchemaParameters
| className | string | |
| format | string | |
| type | string | |
| operation | `ApiPlatform\Metadata\Operation` | |
| schema | `ApiPlatform\JsonSchema\Schema` | |
| serializerContext | array | |
| forceCollection | bool |
Returns
<a href="/docs/references/JsonSchema/Schema">ApiPlatform\JsonSchema\Schema</a>
