wfelipew/swagger-module

Zend Framework 2 Module for Swagger resource file generation

2.0 2016-02-12 10:50 UTC

Requires

• php: >=5.3.3
• zircote/swagger-php: ~2.0

Apache-2.0

• rest
• api
• zf2
• swagger

README

A Zend Framework 2 module that allows the generation of Swagger compliant resource files and is based on swagger-php.

Requirements

• PHP 5.3 or higher
• Zend Framework 2

Installation

Installation of SwaggerModule uses composer. For composer documentation, please refer to getcomposer.org.

Installation steps

1. cd my/project/directory

2. create a composer.json file with following contents:

   {
       "require": {
           "outeredge/swagger-module": "dev-master"
       }
   }

3. install composer via curl -s http://getcomposer.org/installer | php (on windows, download http://getcomposer.org/installer and execute it with PHP)

4. run php composer.phar install

5. copy config/module.swagger.global.php.dist to your config/autoload folder and modify paths variable

6. open my/project/directory/configs/application.config.php and add the following key to your modules:

   'SwaggerModule',

Usage

See swagger-php for library usage information.

$swagger = $this->getServiceLocator()->get('service.swagger');
echo $swagger->getResource('http://org.local/v1');