datto / json-rpc-validator
Auth extension for JSON-RPC library
Installs: 10 758
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 7
Forks: 2
Open Issues: 0
Requires
- datto/json-rpc-simple: ~4.0
- doctrine/annotations: ~1.3
- symfony/validator: ~3.2
Requires (Dev)
- phpunit/phpunit: ~5.7
This package is not auto-updated.
Last update: 2024-11-09 19:17:46 UTC
README
This is an annotation-based validation extension for the php-json-rpc library. It validates the JSON-RPC API endpoints against well-defined constraints, e.g. type checking, regex checking, etc.
The library depends on symfony/Validator, doctrine/annotations as well as on php-json-rpc-simple.
Examples
Annotate your API endpoint classes like this:
namespace Datto\API; use Datto\JsonRpc\Validator\Validate; use Symfony\Component\Validator\Constraints as Assert; class Math { /** * @Validate(fields={ * "a" = @Assert\Type(type="integer"), * "b" = { * @Assert\Type(type="integer"), * @Assert\NotEqualTo(value="0"), * } * }) */ public function divide($a, $b) { return $a / $b; }
Once you have that, just use it like this. This example uses the Simple\Evaluator
(see php-json-rpc-simple) as underlying mapping mechanism:
$server = new Server(new Validator\Evaluator(new Simple\Evaluator())); $result = $server->reply('{"jsonrpc": "2.0", "method": "math/divide", "params": { "a": 1, "b": 0 }, "id": 1}'); // Because 'b' cannot be 0, this will return // {"jsonrpc":"2.0","id":1,"error":{"code":-32602,"message":"Invalid params"}}
Requirements
- PHP >= 5.3
Installation
"require": { "datto/json-rpc-validator": "~2.0" }
License
This package is released under an open-source license: LGPL-3.0.
Author
Written by Philipp C. Heckel.