scrumworks/openapi-schema

OpenAPI schema reader/generator

v0.14.1 2025-02-28 11:23 UTC

Requires

• php: >=8.1
• ext-json: *
• nette/di: ^3.0
• nette/utils: ^3.1 || ^4.0.4
• scrumworks/property-reader: ^0.8

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.10
• phpstan/phpstan-nette: ^1.2.9
• phpunit/phpunit: ^11
• slevomat/coding-standard: ^8.14
• symplify/easy-coding-standard: ^12.1
• symplify/phpstan-extensions: ^11.4.3

MIT

• Tomas Lang

• openapi

README

Installation

composer require scrumworks/openapi-schema

Example

class User
{
    public string $name;
    public string $surname;
}

class Test
{
    /**
     * @var integer
     */
    public int $test;

    public ?string $name;

    /**
     * @var User[]
     */
    public array $users;
}

$di = new \ScrumWorks\OpenApiSchema\DiContainer();
$schemaParser = $di->getSchemaParser();
$schema = $schemaParser->getEntitySchema('Test');
// Now you can get informations about entity schema
assert($schema->getPropertySchema('test') instanceof \ScrumWorks\OpenApiSchema\ValueSchema\IntegerSchema);

// Getting OpenAPI entity schema (result is PHP array)
$openApiTranslator = $di->getOpenApiTranslator();
$openApiValueSchema = $openApiTranslator->translateValueSchema($schema);

Testing

You can run the tests with:

composer run-script test

Contribution Guide

Feel free to open an Issue or add a Pull request.

Credits

People:

• Tomas Lang
• Adam Lutka