integer-net/magento2-enable-swagger

Adds the option to re-enable Swagger via configuration. It's disabled in production mode sind Magento 2.4.4.

Installs: 73 842

Dependents: 0

Suggesters: 0

Security: 0

Stars: 7

Watchers: 3

Forks: 2

Open Issues: 0

Type:magento2-module

1.0.1 2022-09-16 08:05 UTC

This package is auto-updated.

Last update: 2024-12-16 13:02:51 UTC


README

Latest Version on Packagist Software License

Adds the option to re-enable Swagger via configuration. It's disabled in production mode since Magento 2.4.4.

Installation

  1. Install it into your Magento 2 project with composer:

    composer require integer-net/magento2-enable-swagger
    
  2. Enable module

    bin/magento setup:upgrade
    

Configuration

Enable swagger for your environment:

bin/magento config:set --lock-env dev/swagger/active 1

We recommend using the --lock-env switch so this configuration doesn't get lost when importing a database dump.

We recommend to not enable Swagger if there are no other access restrictions in place. These can be:

  • Required VPN
  • Basic Auth
  • Access restricted to predefined IPs

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@integer-net.de instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.