integer-net / magento2-enable-swagger
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.
IntegerNet_EnableSwagger Magento Module
Adds the option to re-enable Swagger via configuration. It's disabled in production mode since Magento 2.4.4.
Installation
-
Install it into your Magento 2 project with composer:
composer require integer-net/magento2-enable-swagger -
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 [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
[Unreleased]
Added
Changed
Removed
Fixed
Requires 2
| Package | Constraint |
|---|---|
| php | ~7.1||~7.2||~7.3||~7.4||~8.1 |
| magento/framework | ^102.0.0||^103.0.0 |
Requires-dev 7
| Package | Constraint |
|---|---|
| roave/security-advisories | dev-master |
| phpunit/phpunit | ^6.0|^9.0 |
| pds/skeleton | ^1.0 |
| phpro/grumphp | ^v0.21.0 |
| phpstan/phpstan | ^0.12.0 |
| squizlabs/php_codesniffer | ^3.5 |
| magento/magento-coding-standard | @dev |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from integer-net
View vendorGenerate RewriteMap files for Apache from Magento URL rewrites
Magento 2 Health Check
Create an "is_sale" product attribute and update it automatically from the "price" and "special_price" attributes
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.