folksyfolks/l5-swagger

OpenApi or Swagger integration to Laravel

8.6.1 2024-04-19 17:38 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• doctrine/annotations: ^1.0 || ^2.0
• laravel/framework: ^11.0 || ^10.0 || ^9.0 || >=8.40.0 || ^7.0
• swagger-api/swagger-ui: ^3.0 || >=4.1.3
• symfony/yaml: ^5.0 || ^6.0 || ^7.0
• zircote/swagger-php: ^3.2.0 || ^4.0.0

Requires (Dev)

• mockery/mockery: 1.*
• orchestra/testbench: ^9.0 || ^8.0 || 7.* || ^6.15 || 5.*
• php-coveralls/php-coveralls: ^2.0
• phpunit/phpunit: ^11.0 || ^10.0 || ^9.5

MIT

• Darius Matulionis

• documentation
• ui
• api
• laravel
• specification
• swagger
• openapi

README

This is a fork from DarkaOnLine's L5-swagger. The version is locked to version 8.1.0.

For more information on how to use this package, please refer to the original fork.

Changes

The main change from this package is the ability to define, from the "scanOptions" config key, after which processor we want to add our custom processor.

Usage

For the base usage please refer to the original documentation.

As for the custom usage, we simpy added a config key append-processors-after, under scanOptions :

// l5-swagger.php
return [
    'default' => 'default',
    'documentations' => [
       /* ... */
    ],
    'defaults' => [ 
        /* ... */
        'scanOptions' => [
            /* ... */
            'processors' => [
                // new \App\SwaggerProcessors\SchemaQueryParameter(),
            ],

            /**
             * Define after which Open Api's processors we want to happens the custom one.
             */
            'append-processors-after' => \OpenApi\Processors\BuildPaths::class,

            /* ... */
        ],
    /* ... */
];

The default value is \OpenApi\Processors\BuildPaths::class, which is the original value in the original fork.