README

Laravel Swagger会扫描你的Laravel项目端点，并自动为你生成Swagger 2.0文档。

关于

Laravel Swagger基于Laravel的推荐实践。它将解析你的路由并为每个路由生成一个路径对象。如果你在你的控制器操作中注入Form Request类作为请求验证，它也会为具有这些类的每个请求生成参数。对于参数，它将考虑请求是GET/HEAD/DELETE还是POST/PUT/PATCH请求，并尽可能猜测应生成的参数对象类型。如果路由包含路径参数，它也会生成路径参数。最后，此包还会扫描你的操作方法中的任何文档，并将其添加为该路径的摘要和描述，以及任何适当的注释，如@deprecated。

有一点需要注意，这个库倾向于明确性。即使它们有默认值，它也会选择包含键。例如，它选择表示路由有一个废弃的值为false，而不是将其省略。我相信这通过不省略重要信息使阅读文档更容易。如果用户选择省略默认值，文件可以很容易地进行清理。

安装

可以通过在项目根目录中运行 composer require mtrajano/laravel-swagger 来轻松安装此包。

如果你正在运行Laravel版本 < 5.5，请确保将 Mtrajano\LaravelSwagger\SwaggerServiceProvider::class 添加到 config/app.php 文件中的 providers 数组中。

这将注册可用于你的Artisan命令。

你还可以通过在项目根目录中运行 php artisan vendor:publish --provider "Mtrajano\LaravelSwagger\SwaggerServiceProvider" 来覆盖应用程序提供的默认配置，并更改新创建的 config/laravel-swagger.php 文件中的配置。

用法

生成Swagger文档很简单，只需在项目根目录中运行 php artisan laravel-swagger:generate 即可。请注意，该命令将仅在控制台输出结果。如果你希望将文档保存到文件中，可以像这样重定向输出：php artisan laravel-swagger:generate > swagger.json

如果你想为你的部分路由生成文档，可以使用 --filter 参数传递过滤器，例如：php artisan laravel-swagger:generate --filter="/api"

默认情况下，laravel-swagger以JSON格式输出文档，如果你想以YAML格式输出，可以使用 --format 标志覆盖格式。如果你选择这样做，请确保已安装yaml扩展。

格式选项有
json
yaml

示例

假设你有一个路由 /api/users/{id}，它映射到 UserController@show

你的示例控制器可能如下所示

/**
 * Return all the details of a user
 *
 * Returns the user's first name, last name and address
 * Please see the documentation [here](https://example.com/users) for more information
 *
 * @deprecated
 */
class UserController extends Controller
{
    public function show(UserShowRequest $request, $id)
    {
        return User::find($id);
    }
}

FormRequest类可能如下所示

class UserShowRequest extends FormRequest
{
    public function rules()
    {
        return [
            'fields' => 'array'
            'show_relationships' => 'boolean|required'
        ];
    }
}

运行 php artisan laravel-swagger:generate > swagger.json 将生成以下文件

{
    "swagger": "2.0",
    "info": {
        "title": "Laravel",
        "description": "Test",
        "version": "1.0.1"
    },
    "host": "http:\/\/localhost",
    "basePath": "\/",
    "paths": {
        "\/api\/user\/{id}": {
            "get": {
                "summary": "Return all the details of a user",
                "description": "Returns the user's first name, last name and address
 Please see the documentation [here](https://example.com/users) for more information",
                "deprecated": true
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                },
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "type": "integer",
                        "required": true,
                        "description": ""
                    },
                    {
                        "in": "query",
                        "name": "fields",
                        "type": "array",
                        "required": false,
                        "description": ""
                    },
                    {
                        "in": "query",
                        "name": "show_relationships",
                        "type": "boolean",
                        "required": true,
                        "description": ""
                    }
                ]
            },
            ...
        }
    }
}