Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk

PHP Sdk to convert symfony constraints to JSON-RPC doc
https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk

documentation-generator json-rpc jsonrpc-server-doc-sdk php sdk symfony-constraint

Last synced: 2 months ago
JSON representation

PHP Sdk to convert symfony constraints to JSON-RPC doc

Host: GitHub
URL: https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk
Owner: yoanm
License: mit
Created: 2018-05-20T18:46:20.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-06-30T21:58:33.000Z (6 months ago)
Last Synced: 2024-10-03T07:09:26.180Z (3 months ago)
Topics: documentation-generator, json-rpc, jsonrpc-server-doc-sdk, php, sdk, symfony-constraint
Language: Gherkin
Homepage:
Size: 123 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 2
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

        # JSON-RPC params symfony constraint doc

[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk)

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

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

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

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

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

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

[![codecov](https://codecov.io/gh/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk)

[![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/jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-params-symfony-constraint-doc-sdk)

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

PHP SDK to generate JSON-RPC documentation from symfony constraint

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

## Versions

*   Symfony v3/4 PHP >=7.1 : `v0.x`

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

*   Symfony v4.4/5.4/6.x PHP ^8.0 : `v1.1`

## How to use

Create the transformer :

```php

use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\ConstraintPayloadDocHelper;

use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\DocTypeHelper;

use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\MinMaxHelper;

use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\StringDocHelper;

use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\TypeGuesser;

use Yoanm\JsonRpcParamsSymfonyConstraintDoc\Infra\Transformer\ConstraintToParamsDocTransformer;

$constraintPayloadDocHelper = new ConstraintPayloadDocHelper();

$transformer = new ConstraintToParamsDocTransformer(

  new DocTypeHelper(

    $constraintPayloadDocHelper,

    new TypeGuesser()

  ),

  new StringDocHelper(),

  new MinMaxHelper(),

  $constraintPayloadDocHelper

);

```

Then use it with single constraint or a list of :

```php

use Symfony\Component\Validator\Constraints as ConstraintNS;

use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ObjectDoc;

use Yoanm\JsonRpcServerDoc\Domain\Model\Type\StringDoc;

$constraint = new ConstraintNS\Collection([

  'a' => new ConstraintNS\Type('string'),

  'b' => new ConstraintNS\Type('integer'),

  'c' => new ConstraintNS\Type('bool')

]);

/** @var ObjectDoc $constraintDoc */

$constraintDoc = $transformer->transform($constraint);

/** @var StringDoc $constraintDoc2 */

$constraintDoc2 = $transformer->transformList([

  new ConstraintNS\Type('string'),

  new ConstraintNS\NotNull()

]);

```

## Contributing

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