waffler/opengen

Waffler client generator using openapi specs

1.0.2 2022-09-05 22:31 UTC

Requires

• php: ^8.0
• cebe/php-openapi: ^1.6.0
• nette/php-generator: ^3.6
• symfony/filesystem: ^6.0
• waffler/waffler: ^1.1.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• jetbrains/phpstorm-attributes: dev-master
• mockery/mockery: ^1.4
• phpunit/phpunit: ^9.5.10
• vimeo/psalm: ^4.22

MIT

• ErickJMenezes

README

This package reads an open api file (like swagger) and generates ready-to-use waffler interfaces.

Supported OpenApi specs:

Name	Version
Swagger	2.0
Open Api	3.0.x

How to install

composer require waffler/opengen

** This package requires PHP 8 or above. **

How to use

<?php

require __DIR__.'/vendor/autoload.php';

use Waffler\OpenGen\ClientGenerator;
use \Waffler\OpenGen\Adapters\OpenApiV3Adapter;

$generator = new ClientGenerator(new OpenApiV3Adapter(
    'FooBar\\Namespace',
));

$generationMap = $generator->generateFromYamlFile(
    'path/to/openapi-file.yaml',
    'path/to/output-dir/',
);

Generation options:

Option: interface_suffix:

Adding this option, you can modify the ClientInterface interface suffix.

• Type: string

Example code:

[
    'interface_suffix' => 'Api' // Replaces 'ClientInterface'
]

Option: ignore:

Adding this option, you can specify elements to ignore in the code generation. Available items to ignore are:

• parameters
• methods

Example code:

[
    'ignore' => [
        'parameters' => [],
        'methods' => []
    ]
]

Option: ignore.parameters:

Adding this option, you can specify which parameter types you want to ignore in the code generation. Available parameter types are:

• header
• query
• path
• formData

Example code:

[
    'ignore' => [
        'parameters' => [
            'header' => ['Authorization', 'other_header_name']
        ]
    ]
]

Option: ignore.methods:

Adding this option, you can specify which method names you want to ignore in the code generation. The method names are the operationId in openapi spec files.

Example code:

[
    'ignore' => [
        'methods' => ['getById', 'deleteUser']
    ]
]

Option: remove_method_prefix:

Adding this option, you can remove the prefix of operationIds from code generation. In the example below, we`ll

Example code:

[
    'remove_method_prefix' => '/\w*\//'
]