folksyfolks / l5-swagger

Laravel 的 OpenApi 或 Swagger 集成

维护者

详细信息

github.com/folksyfolks/L5-Swagger

支持包维护！
DarkaOnLine

安装次数: 2,476

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

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT d28467c6876e72ecf5c5726247716aa39e8a1925

Darius Matulionis <darius.woop@matulionis.lt>

documentation ui api laravel specification swagger openapi

This package is auto-updated.

Last update: 2024-09-19 18:39:26 UTC

README

这是一个从 DarkaOnLine 的 L5-swagger 分支出来的版本。版本锁定为 8.1.0。

有关如何使用此包的更多信息，请参阅原始分支的文档。

变更

此包的主要变化是能够从 "scanOptions" 配置键定义，我们想在哪个处理器后添加我们的自定义处理器。

使用方法

有关基本用法，请参阅原始文档。

至于自定义用法，我们在 scanOptions 下简单地添加了一个配置键 append-processors-after。

// 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,

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

默认值为 \OpenApi\Processors\BuildPaths::class，这是原始分支中的原始值。