insidion/swagger-bundle

Generate Swagger documentation

Installs: 331

Dependents: 1

Suggesters: 0

Security: 0

Stars: 2

Watchers: 5

Forks: 3

Open Issues: 0

Language:JavaScript

Type:symfony-bundle

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

This package is auto-updated.

Last update: 2020-11-05 09:58:37 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.