kbrabrand/silex-swagger-ui

一个将Swagger UI文档浏览器集成到Silex中的Silex服务提供者

维护者

详细信息

github.com/kbrabrand/silex-swagger-ui

源代码

问题

安装次数: 13,379

依赖者: 0

建议者: 0

安全性: 0

星标: 6

关注者: 2

分支: 10

开放问题: 2

语言: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-09-15 03:29:12 UTC

README

一个将Swagger UI文档浏览器集成到Silex中的Silex服务提供者。不依赖于Silex以外的任何东西。

安装

将 "kbrabrand/silex-swagger-ui": "dev-master" 添加到你的composer.json文件中，并在项目根目录下运行 composer install。

除此之外，你还需要在Silex应用中注册该服务，如下所示；

// 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'
));

这将使SwaggerUI界面在Silex应用根目录下的/v1/swagger处可用。配置选项swaggerui.apiDovPath指定了Swagger文档文件的URL/path。

已知问题

由于静态资源是通过Silex控制器提供的，并且尚未设置缓存，Swagger UI目前运行速度较慢。我会尽快解决这个问题。

许可证

版权所有 (c) 2014, Kristoffer Brabrand kristoffer@brabrand.no

许可协议：MIT