batyukovstudio/apiato-swagger-generator

Apiato 的 Swagger 文档生成器

维护者

详细信息

github.com/batyukovstudio/apiato-swagger-generator

源代码

问题

安装: 161

依赖项: 0

建议者: 0

安全性: 0

星标: 5

关注者: 1

分支: 0

开放问题: 0

1.0.0 2024-09-12 11:26 UTC

Requires

Requires (Dev)

MIT e28801cb127881570d7f8a913f571a041f8aaecd

  • batyukovstudio.com <batyukovstudio.woop@gmail.com>

This package is auto-updated.

Last update: 2024-10-01 13:25:07 UTC

README

要求

  • PHP 8.1+
  • Laravel 10+
  • Apiato 10+
  • PHPUnit 10+

安装

通过 composer 安装此包，运行

composer require batyukovstudio/apiato-swagger-generator

用法

生成文档基础

php artisan swagger:generate

运行测试

php artisan test

测试集成

  1. 使用 apiato 设置 PHPUnit: https://apiato.io/docs/components/optional-components/tests/
  2. 包含 Batyukovstudio\ApiatoSwaggerGenerator\PhpUnitExtension 扩展（见 phpunit.example.test）
<extensions>
    <bootstrap class="Batyukovstudio\ApiatoSwaggerGenerator\PhpUnitExtension">
    </bootstrap>
</extensions>
  1. 在主 Kernel 类（Apiato 中的 HttpKernel）中注册全局中间件
use Batyukovstudio\ApiatoSwaggerGenerator\Middlewares\SwaggerGeneratorMiddleware;

class HttpKernel extends LaravelHttpKernel
{
    protected $middleware = [
        // Laravel middlewares
        SwaggerGeneratorMiddleware::class,
        // other middlewares
    ];
}
  1. 将 trait 导入父 TestCase 以启用记录测试响应
use Batyukovstudio\ApiatoSwaggerGenerator\Traits\CanRecordTestResponses;

class YourParentTestCase extends AbstractTestCase
{
    use CanRecordTestResponses;
}
  1. 享受它 😇😇😇