rossity / php-quickbase

Quick Base RESTful API 实现他们的 OpenAPI 规范。

v0.2.1 2021-01-08 14:45 UTC

This package is auto-updated.

Last update: 2024-09-08 22:53:49 UTC


README

Quick Base RESTful API 实现他们的 OpenAPI 规范。

安装与使用

需求

PHP 7.2 及以上。

Composer

要通过 Composer 安装绑定,请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/rossity/php-quickbase.git"
    }
  ],
  "require": {
    "rossity/php-quickbase": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

<?php
require_once('/path/to/Rossity/PhpQuickbase/vendor/autoload.php');

入门指南

请按照 安装过程 进行操作,然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new Rossity\PhpQuickbase\Api\AppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$appId = 'appId_example'; // string | The unique identifier of an app
$qBRealmHostname = 'qBRealmHostname_example'; // string | Your Quick Base domain, for example demo.quickbase.com
$authorization = 'authorization_example'; // string | The Quick Base authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).
$userAgent = 'userAgent_example'; // string | Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
$generated = new \Rossity\PhpQuickbase\Model\InlineObject3(); // \Rossity\PhpQuickbase\Model\InlineObject3

try {
    $result = $apiInstance->copyApp($appId, $qBRealmHostname, $authorization, $userAgent, $generated);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppsApi->copyApp: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都相对于 https://api.quickbase.com/v1

模型

授权

所有端点都不需要授权。

测试

要运行测试,使用

composer install
vendor/bin/phpunit

关于此包

  • API 版本: 1.0.0
  • 构建包: org.openapitools.codegen.languages.PhpClientCodegen