insidion/swagger-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Generate Swagger documentation

2.0.0-alpha4 2018-02-22 23:25 UTC

Requires

• php: >= 5.6
• doctrine/annotations: ^1.4
• psr/cache: ^1.0
• symfony/filesystem: ^3.3
• symfony/framework-bundle: ^3.3
• symfony/routing: ^3.3

Requires (Dev)

• phpunit/phpunit: ^5
• symfony/phpunit-bridge: ^4.0

Suggests

• phpfastcache/phpfastcache: ^5.0 || ^6.0

MIT

• Georges.L
• Mitchell Herrijgers

• api
• bundle
• doc
• swagger

README

Integrate the power of swagger.io in your Symfony 3 application.

If you have not hear about swagger yet, I suggest you take a look at it. It defined a service contract for your REST API. It also provides you with a built-in web interface to execute request with provided example models.

However, writing one yourself can becom tedious, and thus I introduce this bundle!

Features

• Annotation-based REST API definition - Make your code self-documented
• Integrated Swagger UI. Visit <your_site>/swagger/ to use it. - Makes testing easier.
• Definition generated is fully compliant with the swagger standard
• Only generate your swagger.json on startup - Caching (enabled by default)

To be Implemented

I currently have plans to implement these features in the future:

• Security settings
• FOSRestBundle Versioning integration

Have another suggestion? Send me an e-mail at [e-mail]

More documentation

I won't leave you in the dark to figure out how the bundle works. You can find documentation in the Resources/doc folder.