This repository has moved to laminas-api-tools/api-tools-documentation-swagger.
This module provides Apigility the ability to show API documentation through a Swagger UI.
The Swagger UI is immediately accessible after enabling this module at the URI path /apigility/swagger.
In addition to providing the HTML UI, this module also plugs into the main Apigility documentation
resource (at the path /apigility/documentation) in order to allow returning a documentation
payload in the application/vnd.swagger+json media type; this resource is what feeds the Swagger
UI. You can access this representation by passing the media type application/vnd.swagger+json for
the Accept header via the path /apigility/documentation/:module/:service.
Please see the composer.json file.
Run the following composer command:
$ composer require zfcampus/zf-apigility-documentation-swaggerAlternately, manually add the following to your composer.json, in the require section:
"require": {
"zfcampus/zf-apigility-documentation-swagger": "^1.2"
}And then run composer update to ensure the module is installed.
Finally, add the module name to your project's config/application.config.php under the modules
key:
return [
/* ... */
'modules' => [
/* ... */
'ZF\Apigility\Documentation\Swagger',
],
/* ... */
];If you use zf-component-installer, that plugin will install zf-apigility-documentation-swagger as a module for you.
Shows the Swagger UI JavaScript application.
Various CSS, images, and JavaScript libraries required to deliver the Swagger UI client application.
The following is required to ensure the module works within a ZF2 and/or Apigility-enabled application:
namespace ZF\Apigility\Documentation\Swagger;
return [
'router' => [
'routes' => [
'zf-apigility' => [
'child_routes' => [
'swagger' => [
'type' => 'segment',
'options' => [
'route' => '/swagger',
'defaults' => [
'controller' => SwaggerUi::class,
'action' => 'list',
],
],
'may_terminate' => true,
'child_routes' => [
'api' => [
'type' => 'segment',
'options' => [
'route' => '/:api',
'defaults' => [
'action' => 'show',
],
],
'may_terminate' => true,
],
],
],
],
],
],
],
'service_manager' => [
'factories' => [
SwaggerViewStrategy::class => SwaggerViewStrategyFactory::class,
],
],
'controllers' => [
'factories' => [
SwaggerUi::class => SwaggerUiControllerFactory::class,
],
],
'view_manager' => [
'template_path_stack' => [
'zf-apigility-documentation-swagger' => __DIR__ . '/../view',
],
],
'asset_manager' => [
'resolver_configs' => [
'paths' => [
__DIR__ . '/../asset',
],
],
],
'zf-content-negotiation' => [
'accept_whitelist' => [
'ZF\Apigility\Documentation\Controller' => [
0 => 'application/vnd.swagger+json',
],
],
'selectors' => [
'Documentation' => [
ViewModel::class => [
'application/vnd.swagger+json',
],
],
],
],
];This listener is attached to the MvcEvent::EVENT_RENDER event at priority 100. Its purpose is
to conditionally attach a view strategy to the view system in cases where the controller response is
a ZF\Apigility\Documentation\Swagger\ViewModel view model (likely selected as the
content-negotiated view model based off of Accept media types).
This view model is responsible for translating the available ZF\Apigility\Documentation models
into Swagger-specific models, and further casting them to arrays for later rendering as JSON.