2017 © Pedro Peláez
 

symfony-bundle insidion-swagger-acme-bundle

Swagger Acme Bundle

image

phpsocialnetwork/insidion-swagger-acme-bundle

Swagger Acme Bundle

  • Sunday, February 25, 2018
  • by Geolim4
  • Repository
  • 3 Watchers
  • 0 Stars
  • 1 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

Insidion Swagger Bundle

:warning: THE V2 IS CURRENTLY IN DEVELOPMENT, IT IS NOT INTENDED YET FOR PRODUCTION USE :warning:

Why would you need that bundle ?

You need it because it integrate the power of swagger.io in your Symfony 3 application., (*1)

If you have not hear about swagger yet, we suggest you take a look at it. It defines a service contract for your REST API., (*2)

Why should I define a service contract for my Symfony REST API ?

  • Don't you love well-done and documented work ?
  • Don't you hate writing redundant PDF/Excel to explain all your REST api endpoints ?
  • Don't you prefer documenting you code in the same time than you write it ?

Fall for it, you wont be disappointed !, (*3)

What's your bundle provides exactly ?

It provides you a pretty built-in web interface to execute REST requests with provided example models., (*4)

The built-in web interface allows you to test most of HTTP REST methods (DELETE, PATCH, etc), with custom headers/parameters/cookies., (*5)

Writing one yourself can becoming tedious, thus we introduced this bundle!, (*6)

Current features

  • Annotation-based REST API definition - Make your code self-documented
  • Integrated Swagger UI
    • Visit /swagger/ to use it
    • Feel free to use your own route by checking out the Resources/doc folder
  • Makes testing easier.
  • Only generate your swagger.json on startup by configuring the cache
    • The bundle also support a custom Psr6 cache service for handling the cache
  • Definition generated is fully compliant with the swagger standards
  • Security settings
  • Tags definitions
  • Deprecation highlighting
  • Summary/Description available for route and parameters definitions
  • Models definitions for a better contract specification

More documentation

We won't leave you in the dark to figure out how the bundle works., (*7)

You can find documentation in the Resources/doc folder., (*8)

Helping / Contributing

Found an issue ? Feel free to report it., (*9)

Got an idea that improved your experience ? Send us a pull request., (*10)

Having a feedback ? Send us a message, seriously, we'd love to hear from you !, (*11)

Thanks for giving us a try :blue_heart:, (*12)

The Versions