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

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

v0.3.3 2020-03-27 17:16 UTC

This package is auto-updated.

Last update: 2024-08-29 05:29:13 UTC


README

License Code size Dependabot Status

Scrutinizer Build Status Scrutinizer Code Quality Code Coverage

Travis Build Status Travis Symfony Versions

Latest Stable Version Packagist PHP version

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

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

使用方法

配置完成后,您的项目将自动生成 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],
        ...
    ];
  • 按照 adgoal/symfony-jsonrpc-http-server 文档中的说明配置 adgoal/symfony-jsonrpc-http-server

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

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

 

贡献

请参阅 贡献指南