README

此分支使用 Swagger-spec 2.0 和 Swagger-php 2.0。此分支还将 Swagger-ui 更新到版本 2.1.1。

OAuth2

Swagger-ui 已更改，允许直接在 ui 中插入 OAuth 2 参数（client_id、client_secret、realm 和 appName）。您还可以将这些值通过 URL 传递，如下所示： http://api.appcursos.com/api-docs?client_id=my-client-id&client_secret=my-client-secret&realm=my-realm&appName=my-app-name

要使用 Swaggervel 为 Laravel 4.2，请使用 1.0 分支（https://github.com/slampenny/Swaggervel/tree/1.0）

Swaggervel

Swagger for Laravel

此软件包将 Swagger-php 和 swagger-ui 结合成一个 Laravel 适配的软件包。

当您以调试模式运行您的应用程序时，Swaggervel 将扫描您的应用程序文件夹（或在软件包配置中设置在 "app-dir" 变量下的任何文件夹），生成 swagger json 文件并将它们存放在 doc-dir 文件夹（默认为 /docs）。然后文件由 swagger-ui 在 api-docs 目录下提供。

安装

• 将 Jlapp\Swaggervel\SwaggervelServiceProvider 添加到 app/config/app.php 中的 providers 数组，在您的路由提供程序之上，以避免任何捕获所有路由
• 运行 php artisan vendor:publish 将 swagger-ui 推送到您的公共文件夹。

示例

• www.example.com/docs <- swagger JSON 文件可见
• www.example.com/api-docs <- swagger ui 可见。

选项

在配置文件中取消注释 "viewHeaders" 选项以添加标题到您的视图。

如何使用 Swagger-php

实际的 Swagger 规范超出了本软件包的范围。Swaggervel 做的只是以 Laravel 适配的方式打包 swagger-php 和 swagger-ui，并尝试使其易于提供。有关如何使用 swagger-php 的信息，请参阅此处。有关 swagger-php 的良好示例，请参阅此处。

对于 Laravel 5，请使用 2.0 分支！

对于 Laravel 4，请使用 1.0 分支！

Swaggervel

Swagger for Laravel

此软件包将 Swagger-php 和 swagger-ui 结合成一个 Laravel 适配的软件包。

当您以调试模式运行您的应用程序时，Swaggervel 将扫描您的应用程序文件夹（或在软件包配置中设置在 "app-dir" 变量下的任何文件夹），生成 swagger json 文件并将它们存放在 doc-dir 文件夹（默认为 /docs）。然后文件由 swagger-ui 在 api-docs 目录下提供。

安装

• 将 Jlapp\Swaggervel\SwaggervelServiceProvider 添加到您的 providers 数组在 app/config/app.php 中的路由提供程序之上（以避免捕获所有路由）
• 运行 php artisan vendor:publish 将配置文件推送到您的应用程序文件夹。

示例

• www.example.com/docs <- swagger JSON 文件可见
• www.example.com/api-docs <- swagger ui 可见。

选项

在配置文件中取消注释 "viewHeaders" 选项以添加标题到您的视图。

如何使用 Swagger-php

实际的 Swagger 规范超出了本软件包的范围。Swaggervel 做的只是以 Laravel 适配的方式打包 swagger-php 和 swagger-ui，并尝试使其易于提供。有关如何使用 swagger-php 的信息，请参阅此处。有关 swagger-php 的良好示例，请参阅此处。