https://github.com/outeredge/swaggermodule
Swagger Module for ZF2 & ZF3
https://github.com/outeredge/swaggermodule
Last synced: 8 months ago
JSON representation
Swagger Module for ZF2 & ZF3
- Host: GitHub
- URL: https://github.com/outeredge/swaggermodule
- Owner: outeredge
- Created: 2012-05-09T00:48:12.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2021-01-12T13:30:38.000Z (over 5 years ago)
- Last Synced: 2025-04-07T19:09:29.507Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 47.9 KB
- Stars: 23
- Watchers: 2
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SwaggerModule
A Zend Framework module that allows the generation of Swagger compliant resource files and is based on [swagger-php](https://github.com/zircote/swagger-php).
## Installation
The recommended way to install
[`outeredge/swagger-module`](https://packagist.org/packages/outeredge/swagger-module) is through
[composer](http://getcomposer.org/):
```sh
php composer.phar require outeredge/swagger-module
```
You can then enable this module in your `config/application.config.php` by adding
`SwaggerModule` to the `modules` key:
```php
// ...
'modules' => array(
// ...
'SwaggerModule'
),
```
## Configuration
Copy `config/module.swagger.global.php.dist` to your config/autoload folder and modify paths variable
## Usage
See [swagger-php](https://github.com/zircote/swagger-php#readme) for library usage information.
```php
$swagger = $this->getServiceLocator()->get('service.swagger');
echo $swagger->getResource('http://org.local/v1');
```