ptx/lumen-yaml-swagger

Swagger文档，使用PHP注释的可读性差，维护性差，建议使用YAML格式

维护者

详细信息

github.com/putianxin/lumen-yaml-swagger

主页

源代码

问题

安装次数: 5

依赖者: 1

建议者: 0

安全性: 0

星标: 2

关注者: 3

分支: 0

开放问题: 0

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

Requires

Requires (Dev)

MIT 1161d9230b69c7c358a05afd3af162c48c67f90d

  • ptx <putianxin.woop@vip.qq.com>

yamlswaggerlumenPtxTech

This package is not auto-updated.

Last update: 2024-09-29 05:55:21 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文档