How to install the Swagger adapter

To activate the Swagger adapter for the API documentation, you need to require the following dependency by running:

$ composer require laminas-api-tools/api-tools-documentation-swagger

After installation of api-tools-documentation-swagger, enable the module in config/modules.config.php file. Add the following line after 'Laminas\ApiTools\Documentation':



If you are using API Tools 1.4, or have previously installed laminas/laminas-component-installer, it will prompt you to install the module in your configuration.

At this point, you can access the Swagger documentation from the welcome screen, by clicking on the Swagger API documentation button, or by going directly to the /api-tools/swagger URI (relative to your application). The initial page will list available APIs and versions; click the version of the API you wish to view, and you will be taken to a Swagger UI representation of the API.

Swagger UI

Images in the documentation, and the API Tools Admin UI itself, still refer to Apigility. This is due to the fact that we only recently transitioned the project to its new home in the Laminas API Tools. Rest assured that the functionality remains the same.