Download the PHP package basster/silex-simple-swagger-provider without Composer
On this page you can find all versions of the php package basster/silex-simple-swagger-provider. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package silex-simple-swagger-provider
silex-simple-swagger-provider
silex-simple-swagger-provider is a silex service provider that integrates swagger-php (Version 2) into silex. This service provider adds routes for generating and exposing a swagger defintion based on swagger-php annotations. The swagger definition can then be used with swagger-ui.
This library is strongly inspired by Jason Desrosiers silex-swagger-provider but fully rewritten to meet the needs of swagger-php (Version 2)
Installation for Silex 2
Install the silex-swagger-provider using composer.
Parameters
- swagger.servicePath: The path to the classes that contain your swagger annotations.
- swagger.excludePath: A string path or an array of paths to be excluded when generating annotations.
- swagger.apiDocPath: The URI that will be used to access the swagger definition. Defaults to
/api/api-docs. - swagger.cache: An array of caching options that will be passed to Symfony 2's
Response::setCachemethod.
Services
- swagger: An instance of
Swagger\Annotations\Swagger. It's the already parsed swagger annotation tree.
Registering
Usage
The following routes are made available by default
GET /api/api-docs: Get the list of resources
The results of the swagger definition file is not cached internally. Instead, the routes that are created are designed
to work with an HTTP cache such as a browser cache or reverse proxy. You can configure how you want to your service
cached using the swagger.cache parameter. By default, no caching will be done. Read about
HTTP caching in Symfony for more information about how to
customize caching behavior. The following example will allow the service definition file to be cached for 5 days.
