README

关于

swagger-doc-generators 包允许您从验证类中创建 Swagger 文档的注释。

安装

在您的 composer.json 中要求 evolvo/swagger-doc-generators 包，并更新您的依赖关系

$ composer require evolvo/swagger-doc-generators "1.0.8"

添加

Evolvo\SwaggerDocGenerators\SwaggerDocGeneratorsServiceProvider::class,

到 config/app.php 'providers' 数组。

####如果您没有 Swagger 配置和视图文件

运行

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

然后添加

L5Swagger\L5SwaggerServiceProvider::class,

到 config/app.php 'providers' 数组。

添加到 app/Http/Controllers/Controller.php

/**
 * @OA\Info(
 *      version="1.0.0",
 *      title="L5 OpenApi",
 *      description="L5 Swagger OpenApi description",
 *     @OA\License(
 *         name="Apache 2.0",
 *         url="https://apache.ac.cn/licenses/LICENSE-2.0.html"
 *     )
 * )
 */
/*
 * @SWG\SecurityScheme(
 *   securityDefinition="passport",
 *   type="oauth2",
 *   tokenUrl="/oauth/token",
 *   flow="password",
 *   scopes={}
 * )
 */
class Controller extends BaseController
{
    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}

添加到 .env 文件

L5_SWAGGER_GENERATE_ALWAYS=TRUE.

默认预览路由为 http://your-address.com/api/documentation，但您可以在配置中更改它。

使用方法

运行 php artisan comment {METHOD::route} 生成路由的注释。您可以指定多个路由。

运行 php artisan comment:controller {controller} 为整个控制器生成注释。

示例

对于单个路由 php artisan comment GET::api/clients

对于多个路由 php artisan comment GET::api/clients POST::api/clients PUT::api/clients/{client}

对于控制器 php artisan comment:controller ClientsController

自定义文档样式

运行 php artisan swagger-custom-style:apply 应用自定义样式。之后，转到 config/l5-swagger.php 并在 css 数组中更改样式。

示例

运行 php artisan swagger-custom-style:remove 移除自定义样式。

链接和示例

Swagger PHP: 这里

有关 Swagger for Laravel 的更多信息: l5-swagger。

L5-swagger 文档示例: 宠物商店。

宠物商店代码示例: 链接。

我们的公司: http://evolvo.eu。