qixinyun/huizhong-backend-sdk

huizhong backend sdk

0.3 2019-10-18 11:26 UTC

Requires

• qixinyun/huizhong-sdk: ~0.1

Requires (Dev)

• chloroplast/marmot-framework: ~0.3
• fzaninotto/faker: 1.7.1
• pdepend/pdepend: 2.5.2
• phploc/phploc: 4.0.1
• phpmd/phpmd: 2.6.0
• phpunit/phpunit: 6.4.4
• sebastian/phpcpd: 3.0.1
• squizlabs/php_codesniffer: 3.1

MIT

• chloroplast

• backend
• sdk
• huizhong

README

概述

用于集成在内部服务间调用backend服务使用的SDK-php服务, 减少冗余代码, 和重复代码开发.

目录

• 安装说明
• 使用说明
• 版本
• 项目字典

安装说明

composer安装

使用说明

• 初始化
• 错误处理
• 定制参数
• 返回示例
• 政策功能列表
  • 获取单条
  • 获取多条
  • 搜索
• 政策解读功能列表
  • 获取单条
  • 获取多条
  • 搜索
• 政策解读绑定功能

初始化

$sdk = new Sdk\Backend\Sdk('接口地址', array('apikey'=>'密钥'));

错误处理

我们请求一个接口如果返回空数组或者Null对象.

获取接口返回错误id.

$sdk->仓库()->lastErrorId()
...
返回错误id

获取接口返回错误信息

$sdk->仓库()->lastErrorInfo()
...
array(1) {
  'errors' =>
  array(1) {
    [0] =>
    array(8) {
      'id' =>
      string(2) "10"
      'links' =>
      array(1) {
        ...
      }
      'status' =>
      string(3) "404"
      'code' =>
      string(18) "RESOURCE_NOT_EXIST"
      'title' =>
      string(18) "Resource not exist"
      'detail' =>
      string(28) "Server can not find resource"
      'source' =>
      array(0) {
        ...
      }
      'meta' =>
      array(0) {
        ...
      }
    }
  }
}

定制参数

scenario内使用数组格式填写jsonapi的fields和include.

$member = $sdk->仓库()->scenario(array('fields'=>['xxxx'=>'xxxx']))->fetchOne(1);

返回示例

• 单个获取: 返回对象
• 获取多个,搜索: array(int $count, array $objectList)

版本

• 0.1.0

项目字典

沿用huizhonglianhe-backend的项目字典.