Download the PHP package zfcampus/zf-apigility-documentation-swagger without Composer

Swagger Documentation Provider for Apigility

Repository abandoned 2019-12-31

This repository has moved to laminas-api-tools/api-tools-documentation-swagger.

Introduction

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.

Requirements

Please see the composer.json file.

Installation

Run the following composer command:

Alternately, manually add the following to your composer.json, in the require section:

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:

zf-component-installer

If you use zf-component-installer, that plugin will install zf-apigility-documentation-swagger as a module for you.

Routes

/apigility/swagger

Shows the Swagger UI JavaScript application.

Assets: /zf-apigility-documentation-swagger/

Various CSS, images, and JavaScript libraries required to deliver the Swagger UI client application.

Configuration

System Configuration

The following is required to ensure the module works within a ZF2 and/or Apigility-enabled application:

ZF Events

Listeners

ZF\Apigility\Documentation\Swagger\Module

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).

ZF Services

View Models

ZF\Apigility\Documentation\Swagger\ViewModel

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.