Skip to content

Releases: hms5232/laravel-swagger

v0.1.6

18 Aug 07:48
Compare
Choose a tag to compare

What's new

  • Support middleware applying on package route group.
    return [
        'middleware' => [
            //
        ],
    ];
  • Support custom html title of Swagger UI/Editor.
    return [
        'ui' => [
            'title' => env('LARAVEL_SWAGGER_UI_TITLE'),  // add this line
        ],
        'editor' => [
            'title' => env('LARAVEL_SWAGGER_EDITOR_TITLE'),  // add this line
        ],
    ];

See detail comment at config file. And you can re-run publish command with --force flag to override and update the config file.


Thanks for these time, Vicky. Take care.

v0.1.5

03 Apr 10:16
bbbb2d6
Compare
Choose a tag to compare

Changed

  • Drop support for PHP 7 (Laravel 6, 7 and part of 8).
  • Add support for PHP 8.3
  • Add support for Laravel 11.

Full Changelog: v0.1.4...v0.1.5


希望今天的地震下大家都平安

v0.1.4

15 Jul 03:52
Compare
Choose a tag to compare

NEW

  • Support Laravel 6 & 7 but exclude PHP 7.2.

Full Changelog: v0.1.3...v0.1.4

v0.1.3

02 Mar 12:36
ff8b14a
Compare
Choose a tag to compare

NEW

  • Support Laravel 10.
  • You can specify URL of OpenAPI file instead of using APP_URL. This is useful if you have multi domain or you want to hide OpenAPI files and only allow somebody who match rules visit this domain.
    // config/swagger.php
    return [
        'file_url' => env('LARAVEL_SWAGGER_FILE_URL'),
    ];

v0.1.2

19 Nov 04:07
Compare
Choose a tag to compare

New

  • Add support for PHP 7.3, so fully support Laravel 8 now.
  • Integrated Swagger Editor will load index API file set in config by default.
  • You can specify which version of UI/Editor you want to use now. Append the following config in config/swagger.php:
return [
    'ui' => [
        'ver' => env('LARAVEL_SWAGGER_UI_VERSION'),  // add this line
    ],
    'editor' => [
        'ver' => env('LARAVEL_SWAGGER_EDITOR_VERSION'),  // add this line
    ],
]

If null, it will use laravel-swagger default version.

Of course, you can re-run publish command with --force flag to override and update the config file.


Full Changelog: v0.1.1...v0.1.2

v0.1.1

06 Nov 12:19
Compare
Choose a tag to compare

NEW

Swagger Editor integrated!

Append following config in your config/swagger.php:

return [
    /*
    |--------------------------------------------------------------------------
    | Laravel Swagger config of Swagger Editor
    |--------------------------------------------------------------------------
    |
    | This is the config of Swagger Editor. Feel free to change those value
    | to anything you like.
    |
    */
    'editor' => [
        /*
         * This will generate a route to swagger editor.
         * If set null, Laravel Swagger will disable Swagger Editor.
         *
         * Default is: <APP_URL>/swagger-editor
         */
        'path' => env('LARAVEL_SWAGGER_EDITOR_PATH', 'swagger-editor'),
    ],
];

or re-run publish command with --force flag to overwrite exists config.

Disable UI or Editor

Now support disable one/both of Swagger UI or/and Editor. Just set path to null!

For example, youonly use UI and doesn't want to enable Editor, change .env:

LARAVEL_SWAGGER_EDITOR_PATH=null

🎉 Initial release

27 Oct 03:01
Compare
Choose a tag to compare

Thanks DarkaOnLine/L5-Swagger and nextapps-be/laravel-swagger-ui. This package was inspired by them.