搜索kbrabrand / zf2-swagger-ui
ZF2 的 Swagger UI 模块
Requires
- php: >=5.3.3
- zendframework/zendframework: 2.*
This package is auto-updated.
Last update: 2024-09-15 04:10:40 UTC
README
ZF2 模块，将默认的 Swagger UI 接口封装在 ZF2 模块中。
## 安装 推荐使用 composer 安装 Swagger UI for ZF2。将 "kbrabrand/zf2-swagger-ui" : "dev-master" 添加到 composer.json 文件的 require 部分，并执行 composer update 以下载依赖项并生成自动加载。
然后，将模块添加到应用程序配置文件 application.config.php 中的 modules 数组中，添加 "SwaggerUI"。
最后，您需要使资产文件夹可公开访问。这可以通过多种方式完成，但为了简单起见，您可以添加一个符号链接，如下所示；
cd [ZF-app-root]/public && ln -s ../vendor/kbrabrand/zf2-swagger-ui/public swagger-ui
## 配置 该模块有一个可配置选项。如果您想让 Swagger UI 在 ZF2 应用程序的根目录下的 /api/docs 之外的其他地方查找 Swagger JSON，可以将 swagger-ui.global.php.dist 复制到您的 config/autoloads 文件夹中，并将 docs-endpoint 选项设置为所需的任何位置。
## 使用 将模块添加到应用程序配置后，您可以通过访问 /api/swagger 来访问 Swagger UI。
许可证
Swagger UI 模板、图像和 JS 文件
版权所有 2011-2013 Wordnik, Inc.
在 Apache 许可证版本 2.0（“许可证”）下发行；除非适用法律要求或经书面同意，否则不得使用此文件，除非符合许可证。您可以在 apache.org/licenses/LICENSE-2.0 获取许可证副本。
除非适用法律要求或书面同意，否则在许可证下分发的软件按“现状”提供，不提供任何明示或暗示的保证或条件。有关许可证的具体语言、权限和限制，请参阅许可证。
### 其他一切 版权所有 (c) Kristoffer Brabrand kristoffer@brabrand.no
在 MIT 许可证下发行