https://github.com/datto/php-json-rpc-validator
Validation extension for the JSON-RPC library
https://github.com/datto/php-json-rpc-validator
Last synced: about 1 year ago
JSON representation
Validation extension for the JSON-RPC library
- Host: GitHub
- URL: https://github.com/datto/php-json-rpc-validator
- Owner: datto
- License: lgpl-3.0
- Created: 2015-12-14T13:12:31.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-12-19T16:10:23.000Z (over 8 years ago)
- Last Synced: 2025-03-27T18:21:28.484Z (about 1 year ago)
- Language: PHP
- Size: 23.4 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# JSON-RPC Endpoint Validator Extension
This is an annotation-based validation extension for the [php-json-rpc](https://github.com/datto/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](https://github.com/symfony/Validator), [doctrine/annotations](https://github.com/doctrine/annotations) as well as on [php-json-rpc-simple](https://github.com/datto/php-json-rpc-simple).
Examples
--------
Annotate your API endpoint classes like this:
```php
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](https://github.com/datto/php-json-rpc-simple)) as underlying mapping mechanism:
```php
$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
------------
```javascript
"require": {
"datto/json-rpc-validator": "~2.0"
}
```
License
-------
This package is released under an open-source license: [LGPL-3.0](https://www.gnu.org/licenses/lgpl-3.0.html).
Author
------
Written by [Philipp C. Heckel](https://github.com/binwiederhier).