cydrickn/openapi-validator-bundle

Open Api 生成器和验证器

v0.2.0 2022-01-20 14:37 UTC

This package is auto-updated.

Last update: 2024-09-20 20:31:33 UTC


README

Symfony 扩展包,用于基于open api 规范 3 验证请求和响应。

需求

  • Symfony >= 5
  • PHP >= 7.4
  • PHP 扩展 JSON

可选

  • nelmio/api-doc-bundle >= 4.0 (目前处于测试版)
    • 为什么是 4.0?版本 3 和以下版本仅支持 OpenAPI 规范的 2.0 版本。

安装

composer require cydrickn/openapi-validator-bundle

设置

将包添加到您的 config/bundles.php

<?php

return [
    // ...
    Cydrickn\OpenApiValidatorBundle\CydricknOpenApiValidatorBundle::class => ['all' => true],
];

添加配置 config/packages/cydrickn_openapi_validator.yml

cydrickn_open_api_validator:
    validate_request: true
    validate_response: true
    schema:
      factory: yaml-file
      file: %kernel.project_dir%/config/openapi/spec.yaml

配置

待办事项

  • 添加 Nelmio Api Schema Factory
  • 添加动态配置
  • 添加文档
  • 添加路由模式工厂
  • 添加 PHP 文件模式工厂
  • 代码覆盖率 100%
  • 添加 CI
  • 支持 PHP 版本 >= 7.1
  • 支持 Symfony 版本 >= 3