yoanm/symfony-jsonrpc-params-sf-constraints-doc

Symfony扩展包,用于将Symfony约束轻松转换为JSON-RPC文档

v1.1.0 2023-04-10 11:51 UTC

This package is auto-updated.

Last update: 2024-09-10 14:46:24 UTC


README

License Code size Dependabot Status

Scrutinizer Build Status Scrutinizer Code Quality Codacy Badge

CI codecov Symfony Versions

Latest Stable Version Packagist PHP version

Symfony扩展包,用于将Symfony约束轻松转换为JSON-RPC文档

Symfony扩展包,用于yoanm/jsonrpc-params-symfony-constraint-doc-sdk

版本

  • Symfony v3/4 - PHP >=7.1 : ^v0.X
  • Symfony v4/5 - PHP >=7.2 : ^v1.0
  • Symfony v4.4/5.5/6.x - PHP ^8.0 : ^v1.1

如何使用

配置完成后,您的项目将自动创建JSON-RPC参数文档

以下是如何配置的示例。

配置

Behat演示应用程序配置文件夹可以用作示例。

  • 在config/bundles.php文件中添加扩展包

    // config/bundles.php
    return [
        ...
        Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcParamsSfConstraintsDoc\JsonRpcParamsSfConstraintsDocBundle::class => ['all' => true],
        ...
    ];
  • 按照yoanm/symfony-jsonrpc-http-server文档中的说明配置yoanm/symfony-jsonrpc-http-server

  • 按照yoanm/symfony-jsonrpc-http-server-doc文档中的说明配置yoanm/symfony-jsonrpc-http-server-doc

  • 在文档端点查询您的项目,您应该看到每个方法对应的JSON-RPC参数文档

 

贡献

请参阅贡献说明