kbrabrand/silex-swagger-ui

A silex service provider that integrates the Swagger UI documentation browser into silex

Maintainers

Details

github.com/kbrabrand/silex-swagger-ui

Source

Issues

Installs: 13 414

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 2

Forks: 10

Open Issues: 2

Language:JavaScript

1.0.0 2014-11-28 14:36 UTC

Requires

MIT ec2a95a341f7ba13bb7ca16a6930a956273a1361

  • Kristoffer Brabrand <kristoffer.woop@brabrand.no>

silexserviceproviderswaggerswagger-ui

This package is auto-updated.

Last update: 2024-12-15 04:03:11 UTC

README

A silex service provider that integrates the Swagger UI documentation browser into silex. Does not depend on anything besides Silex.

Installation

Add "kbrabrand/silex-swagger-ui": "dev-master" to you composer.json file and run composer install inside the root of your project.

In addition to this you will need to register the service in your Silex app like this;

// Set up swagger ui service for viewing the swagger docs
$app->register(new SwaggerUI\Silex\Provider\SwaggerUIServiceProvider(), array(
    'swaggerui.path'       => '/v1/swagger',
    'swaggerui.apiDocPath' => '/v1/docs'
));

This will result in the SwaggerUI interface being available at /v1/swagger under you Silex application root. The swaggerui.apiDovPath config option specifies the URL/path to the swagger doc files.

Known issues

The Swagger UI is pretty slow right now due to the fact that static resources are served through a Silex controller and no cache is in place (yet). I'll try to fix this soon.

License

Copyright (c) 2014, Kristoffer Brabrand kristoffer@brabrand.no

Licensed under the MIT License