Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicofuma/swaggerbundle
A bundle integrating swagger to validate Requests and Responses
https://github.com/nicofuma/swaggerbundle
behat bundle php swagger symfony symfony-bundle
Last synced: 2 months ago
JSON representation
A bundle integrating swagger to validate Requests and Responses
- Host: GitHub
- URL: https://github.com/nicofuma/swaggerbundle
- Owner: Nicofuma
- License: mit
- Created: 2016-08-24T16:13:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-06T14:13:32.000Z (almost 8 years ago)
- Last Synced: 2024-10-11T00:37:13.251Z (3 months ago)
- Topics: behat, bundle, php, swagger, symfony, symfony-bundle
- Language: PHP
- Size: 213 KB
- Stars: 8
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
NicofumaSwaggerBundle
===============
[](https://packagist.org/packages/nicofuma/swagger-bundle "Latest Stable Version")
[](https://packagist.org/packages/nicofuma/swagger-bundle "Latest Unstable Version")
[](https://packagist.org/packages/nicofuma/swagger-bundle)
[](https://travis-ci.org/Nicofuma/SwaggerBundle "Build status")
[](https://insight.sensiolabs.com/projects/c960afc9-f67d-464b-9c0a-351864e86e7e "SensioLabsInsight")
[](https://scrutinizer-ci.com/g/Nicofuma/SwaggerBundle/?branch=master)
[](https://scrutinizer-ci.com/g/Nicofuma/SwaggerBundle/?branch=master)
Description
-----------
This bundle integrates [Swagger](http://swagger.io/) in Symfony.
Currently, it supports the following features:
- Automatic validation of all incoming requests based on the Swagger definition (including headers and query string)
- Configuring multiple API with different swagger files using configuration
- FOSRestBundle integration: automatic configuration of the ParamFetcher
- Behat integration: context to validate the response
Installation
------------
Add the required package using composer.
### Stable version
```bash
composer require nicofuma/swagger-bundle:^1.0
```
### Bleeding-edge version
```bash
composer require nicofuma/swagger-bundle:@dev
```
### Enabling the bundle
Add the bundle to your AppKernel.
```php
// in %kernel.root_dir%/AppKernel.php
$bundles = array(
// ...
new Nicofuma\SwaggerBundle\NicofumaSwaggerBundle(),
// ...
);
```
Configuration
-------------
```yml
nicofuma_swagger:
definition:
pattern: '/api/v1'
swagger_file: swagger/swagger.json
strict: true
```
`pattern` any url matching this pattern will be tested against the `swagger_file`
`swagger_file` swagger file to use for this API. Can be either an bsolute path, a path relative to `%kernel.root_dir%/Resources/` or a bundle resource `@MyBundle/Dir/swagger.json`
`strict` whether or not an exception must be thrown if the path does not match any definition in the swagger file
Configuration reference
-----------------------
```yml
# Default configuration for extension with alias: "swagger"
nicofuma_swagger:
definitions:
-
pattern:
# use the urldecoded format
path: ^/api/public/
host: null
ips: []
methods: []
swagger_file: swagger-public.json
strict: true
-
pattern:
# use the urldecoded format
path: ^/api/private/
host: null
ips: []
methods: []
swagger_file: swagger-private.json
strict: true
```
Behat integration
-----------------
Add the following context in your behat.yml file
```
- Nicofuma\SwaggerBundle\Tests\Behat\Context\SwaggerContext: {map: '@swagger.validator_map'}
```
Contributing
------------
NicofumaSwaggerBundle is an open source project. If you'd like to contribute, please do.
License
-------
This library is under the MIT license. For the full copyright and license information, please view the [LICENSE]() file that was distributed with this source code.