Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc

Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation
https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc

documentation-generator json-rpc openapi php symfony-bundle symfony-jsonrpc-http-server-doc

Last synced: 28 days ago
JSON representation

Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation

Host: GitHub
URL: https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc
Owner: yoanm
License: mit
Created: 2018-05-13T10:48:42.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-03-31T17:24:14.000Z (8 months ago)
Last Synced: 2024-10-03T07:09:26.175Z (about 1 month ago)
Topics: documentation-generator, json-rpc, openapi, php, symfony-bundle, symfony-jsonrpc-http-server-doc
Language: PHP
Homepage:
Size: 87.9 KB
Stars: 1
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # Symfony JSON-RPC Http server OpenAPI documentation

[![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)

[![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)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\&repo=yoanm/symfony-jsonrpc-http-server-openapi-doc)](https://dependabot.com)

[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/symfony-jsonrpc-http-server-openapi-doc.svg?label=Scrutinizer\&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-openapi-doc/build-status/master)

[![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)

[![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\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)

[![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)

[![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)

[![Symfony Versions](https://img.shields.io/badge/Symfony-v4.4%20%2F%20v5.4%2F%20v6.x-8892BF.svg?logo=github)](https://symfony.com/)

[![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)

[![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)

Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation

Symfony bundle for [yoanm/jsonrpc-http-server-openapi-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)

## Versions

* Symfony v3/4 - PHP >=7.1 : `^v0.X`

* Symfony v4/5 - PHP >=7.2 : `^v1.0`

## How to use

Once configured, your project is ready to handle HTTP `GET` request on `/doc/openapi.json` endpoint. Result will be a openapi compatible file.

See below how to configure it.

## Configuration

[Behat demo app configuration folders](./features/demo_app) can be used as examples.

* Add the bundles in your config/bundles.php file:

  ```php

  // config/bundles.php

  return [

      ...

      Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],

      Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],

      Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],

      Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\JsonRpcHttpServerOpenAPIDocBundle::class => ['all' => true],

      ...

  ];

  ```

* Configure `yoanm/symfony-jsonrpc-http-server` as described on [yoanm/symfony-jsonrpc-http-server](https://github.com/yoanm/symfony-jsonrpc-http-server) documentation.

* 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.

* Query your project at `/doc/openapi.json` endpoint and you will have a OpenAPI json documentation file of your server.

## Event

You are able to enhance resulting documentation by listening on `json_rpc_http_server_openapi_doc.array_created` event.

See below an example of listener service configuration:

```yaml

  method_doc_created.listener:

    class: Full\Namespace\DocCreatedListener # <-- replace by your class name

    tags:

      - name: 'kernel.event_listener'

        event: 'json_rpc_http_server_openapi_doc.array_created'

        method: 'enhanceMethodDoc' # <-- replace by your method name

```

You will receive an event of type [`OpenAPIDocCreatedEvent`](./src/Event/OpenAPIDocCreatedEvent.php).

You can take example on Behat [`DocCreatedListener`](./features/demo_app/src/Listener/DocCreatedListener.php)  

## Contributing

See [contributing note](./CONTRIBUTING.md)