ptx/lumen-yaml-swagger

Swagger文档,用PHP注释可读性差,维护性差,使用YAML格式

v1.0.2 2018-10-16 10:19 UTC

This package is not auto-updated.

Last update: 2024-05-12 03:52:02 UTC


README

Swagger 2.0 for Lumen 5

SwaggerLume 进行封装。 使其支持YAML文档。

安装

composer require --dev ptx/lumenyaml-swagger

bootstrap/app.php

  • 去掉门面注释:
         $app->withFacades();
  • 添加配置加载:
         $app->configure('swagger-lume');
  • 注册服务:
        $app->register(\PtxDev\Swagger\SwaggerLumenServiceProvider::class);

app/Providers/AppServiceProviders.php

  • 添加默认@SWG/Info
      /**
       * @SWG\Swagger(
       *   @SWG\Info(
       *     title="My first swagger documented API",
       *     version="1.0.0"
       *   )
       * )
       */

其它使用见 SwaggerLume 文档