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-doc

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

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

Last synced: 2 months ago
JSON representation

Symfony bundle for easy JSON-RPC server documentation

Host: GitHub
URL: https://github.com/yoanm/symfony-jsonrpc-http-server-doc
Owner: yoanm
License: mit
Created: 2018-05-13T10:07:23.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-06-30T14:09:17.000Z (6 months ago)
Last Synced: 2024-10-03T07:09:29.494Z (3 months ago)
Topics: documentation-generator, json-rpc, jsonrpc-server-doc-sdk, php, symfony-bundle, symfony-jsonrpc-http-server
Language: PHP
Homepage:
Size: 89.8 KB
Stars: 0
Watchers: 3
Forks: 1
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 server documentation

[![License](https://img.shields.io/github/license/yoanm/symfony-jsonrpc-http-server-doc.svg)](https://github.com/yoanm/symfony-jsonrpc-http-server-doc)

[![Code size](https://img.shields.io/github/languages/code-size/yoanm/symfony-jsonrpc-http-server-doc.svg)](https://github.com/yoanm/symfony-jsonrpc-http-server-doc)

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

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

[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/symfony-jsonrpc-http-server-doc/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-doc/?branch=master)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8f39424add044b43a70bdb238e2f48db)](https://www.codacy.com/gh/yoanm/symfony-jsonrpc-http-server-doc/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=yoanm/symfony-jsonrpc-http-server-doc\&utm_campaign=Badge_Grade)

[![CI](https://github.com/yoanm/symfony-jsonrpc-http-server-doc/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/symfony-jsonrpc-http-server-doc/actions/workflows/CI.yml)

[![codecov](https://codecov.io/gh/yoanm/symfony-jsonrpc-http-server-doc/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/symfony-jsonrpc-http-server-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-doc.svg)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-doc)

[![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/symfony-jsonrpc-http-server-doc.svg)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-doc)

Symfony bundle for easy JSON-RPC server documentation

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

See [yoanm/symfony-jsonrpc-params-sf-constraints-doc](https://github.com/yoanm/symfony-jsonrpc-params-sf-constraints-doc) for params documentation generation.

## Availble formats

*   Raw : Built-in `json` format at `/doc` or `/doc/raw.json`

*   Swagger : [yoanm/symfony-jsonrpc-http-server-swagger-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-swagger-doc)

*   OpenApi : [yoanm/symfony-jsonrpc-http-server-openapi-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc)

## How to use

Once configured, your project is ready to handle HTTP `GET` request on `/doc/{?filename}` endpoint.

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],

        ...

    ];

    ```

*   Add the following in your routing configuration :

    ```yaml

    # config/routes.yaml

    json-rpc-endpoint:

      resource: '@JsonRpcHttpServerBundle/Resources/config/routing/endpoint.xml'

    json-rpc-endpoint-doc:

      resource: '@JsonRpcHttpServerDocBundle/Resources/config/routing/endpoint.xml'

    ```

*   Add the following in your configuration :

    ```yaml

    # config/config.yaml

    framework:

      secret: '%env(APP_SECRET)%'

    json_rpc_http_server: ~

    json_rpc_http_server_doc: ~

    # Or the following in case you want to customize endpoint path

    #json_rpc_http_server_doc:

    #  endpoint: '/my-custom-doc-endpoint' # Default to '/doc'

    ```

*   Register JSON-RPC methods as described on [yoanm/symfony-jsonrpc-http-server](https://github.com/yoanm/symfony-jsonrpc-http-server) documentation.

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

## Contributing

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