harness/ff-php-client-api

未提供描述信息(由 Openapi Generator 自动生成 https://github.com/openapitools/openapi-generator)

0.0.1 2022-06-03 19:28 UTC

This package is auto-updated.

Last update: 2024-09-07 19:43:55 UTC


README

未提供描述信息(由 Openapi Generator 自动生成 https://github.com/openapitools/openapi-generator)

如需更多信息,请访问 https://www.harness.io.

安装与使用

要求

PHP 7.4 及以上版本。也应与 PHP 8.0 兼容。

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/harness/ff-php-client-api.git"
    }
  ],
  "require": {
    "harness/ff-php-client-api": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

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

入门指南

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

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




$apiInstance = new OpenAPI\Client\Api\ClientApi(
    // 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()
);
$authentication_request = new \OpenAPI\Client\Model\AuthenticationRequest(); // \OpenAPI\Client\Model\AuthenticationRequest

try {
    $result = $apiInstance->authenticate($authentication_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientApi->authenticate: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都是相对于 https:///api/1.0

模型

授权

ApiKeyAuth

  • 类型: API 密钥
  • API 密钥参数名称: api-key
  • 位置: HTTP 头部

BearerAuth

  • 类型: Bearer 认证(JWT)

测试

要运行测试,使用

composer install
vendor/bin/phpunit

作者

cf@harness.io

关于此包

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

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