klauke-enterprises/netbox-php-client

未提供描述（由Openapi Generator生成 https://github.com/openapitools/openapi-generator)

维护者

详细信息

github.com/klauke-enterprises/netbox-php-client

主页

源代码

问题

安装: 2

依赖项: 0

建议者: 0

安全: 0

星级: 0

观察者: 1

分支: 0

开放问题: 0

dev-main 2024-09-19 12:30 UTC

Requires

Requires (Dev)

unlicense 5628039ca08445f9f7741724838051571880705c

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is not auto-updated.

Last update: 2024-09-20 10:54:40 UTC

README

未提供描述（由Openapi Generator生成 https://github.com/openapitools/openapi-generator)

安装与使用

要求

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 API key authorization: cookieAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Configure API key authorization: tokenAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CircuitsApi(
    // 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
);
$circuit_termination_request = array(new \OpenAPI\Client\Model\CircuitTerminationRequest()); // \OpenAPI\Client\Model\CircuitTerminationRequest[]

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

API 端点

所有 URI 都相对于 https://netbox.demodash.at/api/schema

模型

授权

为API定义的认证方案

cookieAuth

  • 类型：API密钥
  • API密钥参数名称：sessionid
  • 位置:

tokenAuth

  • 类型：API密钥
  • API密钥参数名称：Authorization
  • 位置：HTTP头

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

关于此包

本PHP包由OpenAPI Generator项目自动生成

  • API版本：4.0.8 (4.0)
    • 生成器版本：7.8.0
  • 构建包：org.openapitools.codegen.languages.PhpClientCodegen