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.
- Raw : Built-in
json
format - Swagger : yoanm/jsonrpc-http-server-swagger-doc-sdk
- OpenApi : yoanm/jsonrpc-http-server-openapi-doc-sdk
Available documentation objects:
-
ServerDoc
andHttpServerDoc
for HTTP server MethodDoc
ErrorDoc
-
TagDoc
: Allow to tag methods - Types :
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
andHttpServerDocNormalizer
for HTTP serveruse Yoanm\JsonRpcServerDoc\Infra\Normalizer\ServerDocNormalizer; use Yoanm\JsonRpcServerDoc\Infra\Normalizer\HttpServerDocNormalizer; $normalizer = new ServerDocNormalizer( $methodDocNormalizer, $tagDocNormalizer, $errorDocNormalizer ); $httpNormalizer = new HttpServerDocNormalizer($normalizer);