README

###框架基本信息

通信协议: HTTP
通信框架: GuzzleHttp
消息协议: JSON

该项目使用 composer 来完成加载

执行

composer config repositories.php-rpc-doc vcs git@git.int.haowumc.com:composer/php-rpc-doc.git
composer require itxq/api-doc-php
composer config repositories.php-json-rpc vcs git@git.int.haowumc.com:composer/php-json-rpc.git
composer require paidian/json-rpc:dev-master

代码中启用

注册服务

// Lumen 11
$app->register(\JsonRpc\Providers\LumenServerServiceProvider::class); //rpc server
$app->register(\JsonRpc\Providers\ClientServiceProvider::class); // rpc client

// Laravel 12 (config/app.php -> providers)
JsonRpc\Providers\LaravelServerServiceProvider::class, // rpc server
JsonRpc\Providers\ClientServiceProvider::class, // rpc client

配置

####RPC目录层级


./app/
├── Console
├── Events
├── Exceptions
├── Http
│   ├── Controllers
│   │   ├── DFAPI
│   │   ├── DSPAPI
│   │   ├── ErpAPI
│   ├── Middleware
│   └── Resources
├── Jobs
├── Listeners
├── Logging
├── Logic
├── Models
├── Observers
├── Providers
│   ├── AliyunServiceProvider.php
│   ├── AppServiceProvider.php
│   ├── AuthServiceProvider.php
│   ├── EventServiceProvider.php
│   ├── ObserverServiceProvider.php
│   ├── OssServiceProvider.php
│   └── WechatOauthServiceProvider.php
├── Rpc
│   ├── Order
│   │   └── RpcOrder.php
│   ├── User
│   │   └── RpcUser.php
│   └── method.php //配置文件

####method.php

return [
    //方法名 => [ 类名, 函数名 ]
    'user.info' => [\App\Rpc\User\RpcUser::class, 'getUserInfo'],
    'user.id' => [\App\Rpc\User\RpcUser::class, 'getUserId'],
    'user.relatison' => [\App\Rpc\User\RpcUser::class, 'getUserId'],
    'order.info' => [\App\Rpc\Order\RpcOrder::class, 'getOrderInfo'],
];

发布的rpc方法必须在此文件注册，否则无法访问

####Lumen/Laravel配置config/rpc.php

<?php
return [
    'app' => env('APP_NAME'),
    'log_path' => "/logs/rpc-".date("Y-m-d").".log",//rpc日志路径
    // json rpc server 配置
    'server' => [
        'name' => env('APP_NAME'),
        'map' => base_path('app/Rpc/method.php'), //rpc注册文件
    ],
    // json rpc client 配置
    'client' => [
        'auth' => [
            'local' => false,
            'base_uri' => 'http://hw.api.test',
        ],
        'erp' => [
            'local' => false,
            'base_uri' => 'http://hw.api.test',
        ],
        'sapi' => [
            'local' => true,//当前项目标记为true 
            'base_uri' => 'http://hw.api.test',
        ],
    ],
];

####rpc server文件

<?php
/**
 * Created by PhpStorm.
 * User: dongwei
 * Date: 2019/1/8
 * Time: 11:49 AM
 */
namespace App\Rpc\User;

use JsonRpc\Server\JsonRpcMethod;

/**
 * Class RpcUser
 * @title 用户rpc
 * @package App\Rpc\User
 */
class RpcUser extends JsonRpcMethod
{
    /**
     * @title 获取用户信息
     * @url user.info
     * @method POST
     * @param int uid 用户id 空 必须
     * @param string password 密码
     * @return int code 状态码（具体参见状态码说明）
     */
    public function getUserInfo($uid)
    {
        return $this->response([$uid."abcdefg",123,321,321,3123,1]);
    }

    /**
     * @title 用户登录API
     * @url https://wwww.baidu.com/login
     * @method POST
     * @param string username 账号 空 必须
     * @param string password 密码 空 必须
     * @code 1 成功
     * @code 2 失败
     * @return int code 状态码（具体参见状态码说明）
     * @return string msg 提示信息
     */
    public function getUserId($uid)
    {
        return $this->response([$uid."11ss",1]);
    }
}

####rpc client 调用

$result = app('rpc.sapi')->call('user.info',[13232]);

###工具

http://host/rpc/tool.html 调用工具
http://host/rpc/doc.html 文档地址

###错误码严格使用系统定义错误码详见json-rpc/src/Server/JsonRpcBase.php

###更新日志

###文档注释格式

   /**
     * @title 用户登录API
     * @url https://wwww.baidu.com/login
     * @method POST
     * @param 类型 字段名称 描述 默认 是否必须
     * @param string password 密码 空 必须
     * @code 1 成功
     * @code 2 失败
     * @return int code 状态码（具体参见状态码说明）
     * @return string msg 提示信息
     */

waywake / json-rpc

Maintainers

Details

README

代码中启用

配置