insidion / swagger-bundle
Generate Swagger documentation
Installs: 381
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 7
Forks: 3
Open Issues: 0
Language:JavaScript
Type:symfony-bundle
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
This package is auto-updated.
Last update: 2024-02-05 17:10:20 UTC
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 mitchellherrijgers@gmail.com
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.