lenra/internal-api-client

Lenra 应用程序可用的API

v1.0.0 2023-11-29 13:41 UTC

This package is auto-updated.

Last update: 2024-09-29 15:47:49 UTC


README

Lenra 应用程序可用的API

更多信息,请访问 https://www.lenra.io/contact.html

安装与使用

要求

PHP 7.4 及以上版本。也应适用于 PHP 8.0。

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门

请遵循 安装过程,然后运行以下操作

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



// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\DataApi(
    // 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(),
    $config
);

try {
    $apiInstance->abortTransaction();
} catch (Exception $e) {
    echo 'Exception when calling DataApi->abortTransaction: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都相对于 https://:4001

模型

授权

API 定义的授权方案

bearerAuth

  • 类型:Bearer 认证

测试

要运行测试,请使用

composer install
vendor/bin/phpunit

作者

关于此包

此 PHP 包是由 OpenAPI Generator 项目自动生成的

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