Download the PHP package jdesrosiers/silex-swagger-provider without Composer
On this page you can find all versions of the php package jdesrosiers/silex-swagger-provider. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jdesrosiers/silex-swagger-provider
More information about jdesrosiers/silex-swagger-provider
Files in jdesrosiers/silex-swagger-provider
Package silex-swagger-provider
Short Description A silex service provider that integrates swagger-php into silex
License MIT
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-swagger-provider
silex-swagger-provider
silex-swagger-provider is a silex service provider that integrates swagger-php 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.
Installation
Install the silex-swagger-provider using composer. This project uses sematic versioning.
Parameters
- swagger.srcDir: The path to the swagger-php component.
- swagger.servicePath: The path to the classes that contain your swagger annotations.
- swagger.excludePath: A colon
:separated list 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.prettyPrint: Determines whether or not the JSON generated will be formatted for human readability.
- swagger.cache: An array of caching options that will be passed to Symfony 2's
Response::setCachemethod. - swagger.basePath: The url where your API can be found. If your Swagger annotation contains a basePath it will override this value. Eg. "http://api.example.com/
- swagger.apiVersion: The version of your API. If your Swagger annotation contains a version it will override this value.
- swagger.swaggerVersion: The Swagger version of your API. If your Swagger annotation contains a swagger version it will override this value.
- swagger.resourcePrefix: A prefix string that will be appended for every resource URI. Defaults to "/".
- swagger.resourceSuffix: A suffix string that will be appended for every resource URI. Defaults to "".
Services
- swagger: An instance of
Swagger\Swagger. It's used internally to generate the swagger definition. You probably won't need to use it directly.
Registering
Usage
The following routes are made available by default
GET /api/api-docs: Get the list of resourcesGET /api/api-docs/{service}: Get the definition for a specific resource
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.
Logging
Swagger uses php notices and warnings to log issues it encounters when trying to generate your API documentation. If
your silex application has a logger service, it will log those issues as well.
Getting Started
The following is a minimal example to get you started quickly. It uses the jdesrosiers/silex-cors-provider to allow us to use the demo installation of swagger-ui so we don't have to stand up our own. See the swagger-php documentation for details on how to expand on this example.
-
Create a composer.json with at minimum, the following dependecies
- Run composer install
-
Create /web/index.php
- Run the service
php -S localhost:8000 -t web web/index.php - Go to http://petstore.swagger.io/ and put
http://localhost:8000/api/api-docsin the top input field and clickExplore
