yoanm/jsonrpc-server-doc-sdk

SDK to generate (Http) JSON-RPC server documentation

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

Requires

• php: ^8.0

Requires (Dev)

• ext-json: *
• behat/behat: ^3.9.0
• dvdoug/behat-code-coverage: ^5.0
• phpspec/prophecy: ^1.15
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.5
• yoanm/php-unit-extended: ^2.0

Suggests

• yoanm/jsonrpc-http-server-openapi-doc-sdk: SDK to generate Http JSON-RPC server documentation for OpenAPI v3.0.0
• yoanm/jsonrpc-http-server-swagger-doc-sdk: SDK to generate Http JSON-RPC server documentation for Swagger v2.0
• yoanm/jsonrpc-params-symfony-constraint-doc-sdk: SDK to generate JSON-RPC documentation from symfony constraint
• yoanm/jsonrpc-server-sdk: Server SDK to convert a json-rpc request string into json-rpc response string
• yoanm/symfony-jsonrpc-http-server: Symfony Bundle to convert an HTTP json-rpc request into HTTP json-rpc response
• yoanm/symfony-jsonrpc-http-server-doc: Symfony bundle for easy JSON-RPC server documentation

MIT

• Yoanm

README

Php SDK to generate (Http) JSON-RPC server documentation

See yoanm/symfony-jsonrpc-http-server-doc for automatic dependency injection.

See yoanm/jsonrpc-params-symfony-constraint-doc-sdk for params documentation generation.

Availble formats

• Raw : Built-in json format
• Swagger : yoanm/jsonrpc-http-server-swagger-doc-sdk
• OpenApi : yoanm/jsonrpc-http-server-openapi-doc-sdk

How to use

Php objects

Available documentation objects:

• ServerDoc and HttpServerDoc for HTTP server
• MethodDoc
• ErrorDoc
• TagDoc : Allow to tag methods
• Types :
  • TypeDoc : Basic type
    • BooleanDoc
    • ScalarDoc
      • StringDoc
      • NumberDoc
        • IntegerDoc
        • FloatDoc
    • CollectionDoc
      • ArrayDoc
      • ObjectDoc

Normalizers

Available normalizers :

• 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 and HttpServerDocNormalizer for HTTP server

  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\ServerDocNormalizer;
  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\HttpServerDocNormalizer;
  
  $normalizer = new ServerDocNormalizer(
    $methodDocNormalizer,
    $tagDocNormalizer,
    $errorDocNormalizer
  );
  
  $httpNormalizer = new HttpServerDocNormalizer($normalizer);

Contributing

See contributing note