README

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

要使用此包，请将其添加到composer.json

"repositories": [
        {
          "type": "vcs",
          "url": "https://github.com/tralves/Swaggervel"
        }
    ],
(...)
"require": {
  "jlapp/swaggervel": "master-dev",
}

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使用Swaggervel，请使用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目录下提供服务。

安装

• 在composer.json中要求"pharmit/swaggervel": "dev-master"。
• 将PharmIT\Swaggervel\SwaggervelServiceProvider添加到您的app/config/app.php中的提供者数组，在路由提供者之上，以避免任何捕获所有路由。
• 运行php artisan vendor:publish将swagger-ui推送到您的公共文件夹。
• 将CREDENTIALS_USERNAME=YOUR_USERNAME和CREDENTIALS_PASSWORD=YOUR_PASSWORD添加到您的.env文件中。

示例

• 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添加到您的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在动作中的良好示例，请查看此处。