{"id":15490147,"url":"https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk","last_synced_at":"2026-01-04T01:04:37.655Z","repository":{"id":57087817,"uuid":"133220147","full_name":"yoanm/php-jsonrpc-http-server-openapi-doc-sdk","owner":"yoanm","description":"SDK to generate Http JSON-RPC server documentation for OpenAPI v3.0.0","archived":false,"fork":false,"pushed_at":"2024-03-31T15:12:44.000Z","size":103,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-19T09:04:36.586Z","etag":null,"topics":["documentation-generator","json-rpc","jsonrpc-server-doc-sdk","openapi","php","sdk"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yoanm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-05-13T08:48:40.000Z","updated_at":"2023-04-02T12:37:13.000Z","dependencies_parsed_at":"2024-03-13T13:33:02.189Z","dependency_job_id":"bc61fd5e-6a4d-4de0-b7e7-2d7943dbe2a5","html_url":"https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk","commit_stats":{"total_commits":22,"total_committers":3,"mean_commits":7.333333333333333,"dds":0.09090909090909094,"last_synced_commit":"34a0f32c239b4a160f6339b2a480b093b85b58f7"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-http-server-openapi-doc-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-http-server-openapi-doc-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-http-server-openapi-doc-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-http-server-openapi-doc-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoanm","download_url":"https://codeload.github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243982297,"owners_count":20378606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-generator","json-rpc","jsonrpc-server-doc-sdk","openapi","php","sdk"],"created_at":"2024-10-02T07:09:32.234Z","updated_at":"2026-01-04T01:04:37.644Z","avatar_url":"https://github.com/yoanm.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSON-RPC Http server OpenAPI documentation\n\n[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-http-server-openapi-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)\n[![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-http-server-openapi-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)\n![Dependabot Status](https://flat.badgen.net/github/dependabot/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)\n![Last commit](https://badgen.net/github/last-commit/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)\n\n[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-http-server-openapi-doc-sdk.svg?label=Scrutinizer\\\u0026logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/build-status/master)\n[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/?branch=master)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8f39424add044b43a70bdb238e2f48db)](https://www.codacy.com/gh/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/dashboard?utm_source=github.com\\\u0026utm_medium=referral\\\u0026utm_content=yoanm/php-jsonrpc-http-server-openapi-doc-sdk\\\u0026utm_campaign=Badge_Grade)\n\n[![CI](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/actions/workflows/CI.yml)\n[![codecov](https://codecov.io/gh/yoanm/php-jsonrpc-http-server-openapi-doc-sdk/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)\n\n[![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/jsonrpc-http-server-openapi-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-http-server-openapi-doc-sdk)\n[![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/jsonrpc-http-server-openapi-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-http-server-openapi-doc-sdk)\n\nSDK to generate Http JSON-RPC server documentation for OpenAPI v3.0.0\n\nSee [`yoanm/symfony-jsonrpc-http-server-openapi-doc`](https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc) for automatic dependency injection.\n\n## How to use\n\nCreate the normalizer :\n\n```php\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\ErrorDocNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\ExternalSchemaListDocNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\OperationDocNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\RequestDocNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\ResponseDocNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\SchemaTypeNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\ShapeNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Normalizer\\Component\\TypeDocNormalizer;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\App\\Resolver\\DefinitionRefResolver;\nuse Yoanm\\JsonRpcHttpServerOpenAPIDoc\\Infra\\Normalizer\\DocNormalizer;\n\n$shapeNormalizer = new ShapeNormalizer();\n$definitionRefResolver = new DefinitionRefResolver();\n$typeDocNormalizer = new TypeDocNormalizer(\n    new SchemaTypeNormalizer()\n);\n\n$normalizer = new DocNormalizer(\n    new ExternalSchemaListDocNormalizer(\n        $definitionRefResolver,\n        $typeDocNormalizer,\n        new ErrorDocNormalizer(\n            $typeDocNormalizer,\n            $shapeNormalizer\n        )\n    ),\n    new OperationDocNormalizer(\n        $definitionRefResolver,\n        new RequestDocNormalizer(\n            $definitionRefResolver,\n            $shapeNormalizer\n        ),\n        new ResponseDocNormalizer(\n            $definitionRefResolver,\n            $shapeNormalizer\n        )\n    )\n);\n```\n\nThen you can convert `ServerDoc` or `HttpServerDoc` by doing :\n\n```php\nuse Yoanm\\JsonRpcServerDoc\\Domain\\Model\\ServerDoc;\n\n$serverDoc = new ServerDoc();\n// Configure server doc\n...\n// Add methods documentation\n...\n// Then normalize\n/** @var array $openAPIDoc */\n$openAPIDoc = $normalizer-\u003enormalize($serverDoc);\n```\n\n## Contributing\n\nSee [contributing note](./CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoanm%2Fphp-jsonrpc-http-server-openapi-doc-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoanm%2Fphp-jsonrpc-http-server-openapi-doc-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoanm%2Fphp-jsonrpc-http-server-openapi-doc-sdk/lists"}