paulgessinger / jsonrpc
轻量级JsonRpc API框架。
0.2.3
2014-01-27 21:09 UTC
Requires
- php: >=5.3.0
- monolog/monolog: *
- paulgessinger/common: *
- phpdocumentor/reflection-docblock: 1.0.*
- pimple/pimple: 2.0.*@dev
- symfony/http-foundation: 2.5.*@dev
Requires (Dev)
- mockery/mockery: dev-master@dev
- phpunit/dbunit: >=1.2
- phpunit/phpunit: 3.7.*
This package is not auto-updated.
Last update: 2024-09-28 15:23:44 UTC
README
#PHP的JSONRPC
允许您通过公开任意对象到HTTP POST请求,来编写简单快速的JSON RPC API。
安装
无论如何;请使用Composer!
- 获取Composer
- 将
"paulgessinger/jsonrpc": "dev-master"
添加到您的require中 - 使用
composer install
安装依赖
入门指南
在您的引导文件中放置类似以下内容(例如index.php)。
use PG\JsonRpc\Server ; include __DIR__.'/vendor/autoload.php' ; $server = new Server() ; $server->expose('Sample', 'PG\JsonRpc\tests\sample\Sample') ; $server->run() ;
您可以使用以下JSON格式的POST请求对其执行POST请求
{ "jsonrpc":"2.0", "id":1, "method":"Sample.divide", "params": [11, 5] }
(请参阅JSON RPC规范)。
而示例看起来像
namespace PG\JsonRpc\tests\sample; use PG\JsonRpc\Exception\ArgumentException; class Sample { public function divide($a, $b) { return $a/$b ; } // ... }
您将获得以下形式的响应
{ "jsonrpc":"2.0", "id":1, "result":2.2 }
祝您玩得开心。
测试
该库力求进行全面的单元测试。去试试吧,进入库的根目录并运行phpunit
。PHPUnit也包含在require-dev中,因此您可以通过composer install --dev
或composer update
来获取它。
贡献者
许可证
MIT许可证(MIT)
版权所有(c) 2013 Paul Gessinger
特此授予任何人免费获得本软件及其相关文档文件(“软件”)副本的权限,无限制地处理该软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本,并允许向提供软件的人员做上述事项,前提是遵守以下条件
上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。
软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、特定用途适用性和非侵权性保证。在任何情况下,作者或版权持有人均不对任何索赔、损害或其他责任负责,无论该责任基于合同、侵权或其他原因,是否因软件或其使用或其他方式引起。