solianlg/lumen-yaml-swagger

使用yaml格式文档生成swagger接口文档

维护者

详细信息

github.com/soliangD/lumen-yaml-swagger

源代码

问题

安装: 1

依赖项: 1

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 0

开放问题: 0

1.0.0 2019-04-10 15:19 UTC

Requires

Requires (Dev)

MIT 465825e8ccfdf23d1aff4d8d59f6da62f270c92b

  • soliang <soliang.woop@dingtalk.com>

yamlswaggerlumen

This package is auto-updated.

Last update: 2024-09-29 05:28:31 UTC

README

为Lumen 5提供的Swagger 2.0

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

安装

composer require --dev soliangd/lumen-yaml-swagger

bootstrap/app.php

  • 去掉门面注释
         $app->withFacades();
  • 复制配置并加载
         $app->configure('yaml-swagger');
  • 注册服务
        $app->register(\Soocoo\Swagger\SwaggerLumenServiceProvider::class);
  • 配置YAML目录 config/yaml-swagger.php：
    [
    "paths" => [
        "yaml_annotations" => [base_path('docs')] // 默认目录
    ]
]
  • 路由重定向
    注意nginx配置时将 swagger路由重定向 swagger文档支持
     location ~ /(swagger-ui-assets) {
         index index.php;
         try_files $uri $uri/ /index.php?$query_string;
     }
````php

其他使用方法请参考 SwaggerLume 文档