yoanm/jsonrpc-server-doc-sdk

生成 (Http) JSON-RPC 服务器文档的 SDK

维护者

详细信息

github.com/yoanm/php-jsonrpc-server-doc-sdk

源代码

问题

安装量: 43,591

依赖项: 11

建议者: 1

安全性: 0

星标: 0

关注者: 3

分支: 0

开放问题: 3

v1.0.2 2024-08-30 10:04 UTC

Requires

  • php: ^8.0

Requires (Dev)

Suggests

MIT c3955323b901d4840efc5f2b94fb87dfb7f64523

  • Yoanm <yoanm.woop@users.noreply.github.com>

This package is auto-updated.

Last update: 2024-08-30 10:07:44 UTC

README

License Code size Dependabot Status

Scrutinizer Build Status Scrutinizer Code Quality Codacy Badge

CI codecov

Latest Stable Version Packagist PHP version

生成 (Http) JSON-RPC 服务器文档的 PHP SDK

有关自动依赖注入，请参阅 yoanm/symfony-jsonrpc-http-server-doc

有关参数文档生成，请参阅 yoanm/jsonrpc-params-symfony-constraint-doc-sdk

可用格式

如何使用

PHP 对象

可用的文档对象

标准化器

可用的标准化器

  • TypeDocNormalizer 
    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TypeDocNormalizer;

$typeDocNormalizer = new TypeDocNormalizer();
  • TagDocNormalizer 
    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TagDocNormalizer;

$tagDocNormalizer = new TagDocNormalizer();
  • ErrorDocNormalizer 
    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;

$errorDocNormalizer = new ErrorDocNormalizer($typeDocNormalizer);
  • MethodDocNormalizer 
    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;

$tagDocNormalizer = new MethodDocNormalizer(
  $typeDocNormalizer,
  $errorDocNormalizer
);
  • ServerDocNormalizer 和 HttpServerDocNormalizer 用于 HTTP 服务器
    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\ServerDocNormalizer;
use Yoanm\JsonRpcServerDoc\Infra\Normalizer\HttpServerDocNormalizer;

$normalizer = new ServerDocNormalizer(
  $methodDocNormalizer,
  $tagDocNormalizer,
  $errorDocNormalizer
);

$httpNormalizer = new HttpServerDocNormalizer($normalizer);

贡献

请参阅 贡献指南