README.md

JSON-RPC server documentation

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