{"id":15490148,"url":"https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc","last_synced_at":"2025-06-20T12:05:19.379Z","repository":{"id":57087703,"uuid":"133228103","full_name":"yoanm/symfony-jsonrpc-http-server-openapi-doc","owner":"yoanm","description":"Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation","archived":false,"fork":false,"pushed_at":"2024-03-31T17:24:14.000Z","size":90,"stargazers_count":1,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-19T09:04:38.901Z","etag":null,"topics":["documentation-generator","json-rpc","openapi","php","symfony-bundle","symfony-jsonrpc-http-server-doc"],"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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-13T10:48:42.000Z","updated_at":"2024-03-13T12:12:15.000Z","dependencies_parsed_at":"2024-03-31T17:30:47.109Z","dependency_job_id":null,"html_url":"https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc","commit_stats":{"total_commits":37,"total_committers":3,"mean_commits":"12.333333333333334","dds":0.08108108108108103,"last_synced_commit":"97cb55fd09389207c99001668ebccc1504dbf439"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fsymfony-jsonrpc-http-server-openapi-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fsymfony-jsonrpc-http-server-openapi-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fsymfony-jsonrpc-http-server-openapi-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fsymfony-jsonrpc-http-server-openapi-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoanm","download_url":"https://codeload.github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249594065,"owners_count":21296866,"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","openapi","php","symfony-bundle","symfony-jsonrpc-http-server-doc"],"created_at":"2024-10-02T07:09:32.867Z","updated_at":"2025-04-22T19:08:41.549Z","avatar_url":"https://github.com/yoanm.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Symfony JSON-RPC Http server OpenAPI documentation\n\n[![License](https://img.shields.io/github/license/yoanm/symfony-jsonrpc-http-server-openapi-doc.svg)](https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc)\n[![Code size](https://img.shields.io/github/languages/code-size/yoanm/symfony-jsonrpc-http-server-openapi-doc.svg)](https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc)\n[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\\\u0026repo=yoanm/symfony-jsonrpc-http-server-openapi-doc)](https://dependabot.com)\n\n[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/symfony-jsonrpc-http-server-openapi-doc.svg?label=Scrutinizer\\\u0026logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-openapi-doc/build-status/master)\n[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/symfony-jsonrpc-http-server-openapi-doc/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-openapi-doc/?branch=master)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ef0f7b242e2445dfb3349cb7eb17785b)](https://app.codacy.com/gh/yoanm/symfony-jsonrpc-http-server-openapi-doc/dashboard?utm_source=gh\\\u0026utm_medium=referral\\\u0026utm_content=\\\u0026utm_campaign=Badge_grade)\n\n[![CI](https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc/actions/workflows/CI.yml)\n[![codecov](https://codecov.io/gh/yoanm/symfony-jsonrpc-http-server-openapi-doc/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/symfony-jsonrpc-http-server-openapi-doc)\n[![Symfony Versions](https://img.shields.io/badge/Symfony-v4.4%20%2F%20v5.4%2F%20v6.x-8892BF.svg?logo=github)](https://symfony.com/)\n\n[![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/symfony-jsonrpc-http-server-openapi-doc.svg)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-openapi-doc)\n[![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/symfony-jsonrpc-http-server-openapi-doc.svg)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-openapi-doc)\n\nSymfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation\n\nSymfony bundle for [yoanm/jsonrpc-http-server-openapi-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)\n\n## Versions\n\n* Symfony v3/4 - PHP \u003e=7.1 : `^v0.X`\n* Symfony v4/5 - PHP \u003e=7.2 : `^v1.0`\n\n## How to use\n\nOnce configured, your project is ready to handle HTTP `GET` request on `/doc/openapi.json` endpoint. Result will be a openapi compatible file.\n\nSee below how to configure it.\n\n## Configuration\n\n[Behat demo app configuration folders](./features/demo_app) can be used as examples.\n\n* Add the bundles in your config/bundles.php file:\n  ```php\n  // config/bundles.php\n  return [\n      ...\n      Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle::class =\u003e ['all' =\u003e true],\n      Yoanm\\SymfonyJsonRpcHttpServer\\JsonRpcHttpServerBundle::class =\u003e ['all' =\u003e true],\n      Yoanm\\SymfonyJsonRpcHttpServerDoc\\JsonRpcHttpServerDocBundle::class =\u003e ['all' =\u003e true],\n      Yoanm\\SymfonyJsonRpcHttpServerOpenAPIDoc\\JsonRpcHttpServerOpenAPIDocBundle::class =\u003e ['all' =\u003e true],\n      ...\n  ];\n  ```\n\n* Configure `yoanm/symfony-jsonrpc-http-server` as described on [yoanm/symfony-jsonrpc-http-server](https://github.com/yoanm/symfony-jsonrpc-http-server) documentation.\n\n* Configure `yoanm/symfony-jsonrpc-http-server-doc` as described on [yoanm/symfony-jsonrpc-http-server-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-doc) documentation.\n\n* Query your project at `/doc/openapi.json` endpoint and you will have a OpenAPI json documentation file of your server.\n\n## Event\n\nYou are able to enhance resulting documentation by listening on `json_rpc_http_server_openapi_doc.array_created` event.\n\nSee below an example of listener service configuration:\n\n```yaml\n  method_doc_created.listener:\n    class: Full\\Namespace\\DocCreatedListener # \u003c-- replace by your class name\n    tags:\n      - name: 'kernel.event_listener'\n        event: 'json_rpc_http_server_openapi_doc.array_created'\n        method: 'enhanceMethodDoc' # \u003c-- replace by your method name\n```\n\nYou will receive an event of type [`OpenAPIDocCreatedEvent`](./src/Event/OpenAPIDocCreatedEvent.php).\n\nYou can take example on Behat [`DocCreatedListener`](./features/demo_app/src/Listener/DocCreatedListener.php)  \n\n## Contributing\n\nSee [contributing note](./CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoanm%2Fsymfony-jsonrpc-http-server-openapi-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoanm%2Fsymfony-jsonrpc-http-server-openapi-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoanm%2Fsymfony-jsonrpc-http-server-openapi-doc/lists"}