slis/hub-php-adapter

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

dev-main 2022-08-10 13:17 UTC

README

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

更多信息,请访问 https://slis.services.

安装与使用

需求

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

Composer

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

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

然后运行 composer install

手动安装

下载文件并包含 autoload.php

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

入门

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

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



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


$apiInstance = new SLIS\Adapter\Hub\Api\BenutzerApi(
    // 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
);
$uuid = 'uuid_example'; // string | Resource identifier

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

API 端点

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

方法HTTP 请求描述
BenutzerApideleteBenutzerItemDELETE /benutzers/{uuid}删除 Benutzer 资源。
BenutzerApigetBenutzerCollectionGET /benutzers检索 Benutzer 资源集合。
BenutzerApigetBenutzerItemGET /benutzers/{uuid}检索 Benutzer 资源。
BenutzerApipostBenutzerCollectionPOST /benutzers创建 Benutzer 资源。
BenutzerApiputBenutzerItemPUT /benutzers/{uuid}替换 Benutzer 资源。
BestellungApiapiKundesBestellungensGetSubresourceKundeSubresourceGET /kundes/{uuid}/bestellungens检索 Kunde 资源。
BestellungApideleteBestellungItemDELETE /bestellung/{uuid}删除 Bestellung 资源。
BestellungApigetAvaliblePositionsBestellungCollectionGET /bestellung/positionen/_available获取所有可用订单位置列表
BestellungApigetBestellungCollectionGET /bestellung检索 Bestellung 资源集合。
BestellungApigetBestellungItemGET /bestellung/{uuid}检索 Bestellung 资源。
BestellungApipatchBestellungItemPATCH /bestellung/{uuid}更新 Bestellung 资源。
BestellungApipostBestellungCollectionPOST /bestellung创建 Bestellung 资源。
FirewallApiapiFirewallsServiceLevelAgreementGetSubresourceFirewallSubresourceGET /firewalls/{uuid}/service_level_agreement检索 Firewall 资源。
FirewallApideleteFirewallItemDELETE /firewalls/{uuid}删除 Firewall 资源。
FirewallApigetFirewallCollectionGET /firewalls检索 Firewall 资源集合。
FirewallApigetFirewallItemGET /firewalls/{uuid}检索 Firewall 资源。
FirewallApipostFirewallCollectionPOST /firewalls创建 Firewall 资源。
FirewallApiputFirewallItemPUT /firewalls/{uuid}替换 Firewall 资源。
GeraetApideleteGeraetItemDELETE /geraets/{uuid}删除 Geraet 资源。
GeraetApigetGeraetCollectionGET /geraets检索 Geraet 资源集合。
GeraetApigetGeraetItemGET /geraets/{uuid}检索 Geraet 资源。
GeraetApiputGeraetItemPUT /geraets/{uuid}替换 Geraet 资源。
GeraetTypApideleteGeraetTypItem删除 /geraet-typ/{uuid}删除 GeraetTyp 资源。
GeraetTypApigetGeraetTypCollectionGET /geraet-typ获取 GeraetTyp 资源集合。
GeraetTypApigetGeraetTypItemGET /geraet-typ/{uuid}获取一个 GeraetTyp 资源。
GeraetTypApipostGeraetTypCollectionPOST /geraet-typ创建一个 GeraetTyp 资源。
HerstellerApideleteHerstellerItemDELETE /herstellers/{uuid}删除 Hersteller 资源。
HerstellerApigetHerstellerCollectionGET /herstellers获取 Hersteller 资源集合。
HerstellerApigetHerstellerItemGET /herstellers/{uuid}获取一个 Hersteller 资源。
HerstellerApipostHerstellerCollectionPOST /herstellers创建一个 Hersteller 资源。
HerstellerApiputHerstellerItemPUT /herstellers/{uuid}替换 Hersteller 资源。
KategorieApideleteKategorieItemDELETE /kategories/{name}删除 Kategorie 资源。
KategorieApigetKategorieCollectionGET /kategories获取 Kategorie 资源集合。
KategorieApigetKategorieItemGET /kategories/{name}获取一个 Kategorie 资源。
KategorieApipostKategorieCollectionPOST /kategories创建一个 Kategorie 资源。
KategorieApiputKategorieItemPUT /kategories/{name}替换 Kategorie 资源。
KimApideleteKimItemDELETE /kims/{id}删除 Kim 资源。
KimApigetKimCollectionGET /kims获取 Kim 资源集合。
KimApigetKimItemGET /kims/{id}获取一个 Kim 资源。
KimApipatchKimItemPATCH /kims/{id}更新 Kim 资源。
KimApipostKimCollectionPOST /kims创建一个 Kim 资源。
KimApiputKimItemPUT /kims/{id}替换 Kim 资源。
KundeApiapiKundesBestellungensGetSubresourceKundeSubresourceGET /kundes/{uuid}/bestellungens检索 Kunde 资源。
KundeApideleteKundeItemDELETE /kunden/{uuid}删除 Kunde 资源。
KundeApigetKundeCollectionGET /kunden获取 Kunde 资源集合。
KundeApigetKundeItemGET /kunden/{uuid}检索 Kunde 资源。
KundeApipostKundeCollectionPOST /kunden创建一个 Kunde 资源。
KundeApiputKundeItemPUT /kunden/{uuid}替换 Kunde 资源。
NetzwerkApiapiStandortsNetzwerkesGetSubresourceStandortSubresourceGET /standorts/{uuid}/netzwerkes获取 Standort 资源。
NetzwerkApideleteNetzwerkItemDELETE /netzwerk/{uuid}删除 Netzwerk 资源。
NetzwerkApigetNetzwerkCollectionGET /netzwerk获取 Netzwerk 资源集合。
NetzwerkApigetNetzwerkItemGET /netzwerk/{uuid}获取一个 Netzwerk 资源。
NetzwerkApipostNetzwerkCollectionPOST /netzwerk创建一个 Netzwerk 资源。
ServiceLevelAgreementApiapiFirewallsServiceLevelAgreementGetSubresourceFirewallSubresourceGET /firewalls/{uuid}/service_level_agreement检索 Firewall 资源。
ServiceLevelAgreementApideleteServiceLevelAgreementItemDELETE /sla/{uuid}删除 ServiceLevelAgreement 资源。
ServiceLevelAgreementApigetServiceLevelAgreementCollectionGET /sla获取 ServiceLevelAgreement 资源集合。
ServiceLevelAgreementApigetServiceLevelAgreementItemGET /sla/{uuid}获取一个 ServiceLevelAgreement 资源。
ServiceLevelAgreementApipostServiceLevelAgreementCollectionPOST /sla创建一个 ServiceLevelAgreement 资源。
StandortApiapiStandortsNetzwerkesGetSubresourceStandortSubresourceGET /standorts/{uuid}/netzwerkes获取 Standort 资源。
StandortApideleteStandortItemDELETE /standorte/{uuid}删除 Standort 资源。
StandortApigetStandortCollectionGET /standorte获取 Standort 资源集合。
StandortApigetStandortItemGET /standorte/{uuid}获取 Standort 资源。
StandortApipostStandortCollectionPOST /standorte创建一个 Standort 资源。
StatusApigetStatusCollectionGET /statuses获取 Status 资源集合。
StatusApigetStatusItemGET /statuses/{uuid}获取一个 Status 资源。
TagApideleteTagItemDELETE /tags/{uuid}删除 Tag 资源。
TagApigetTagCollectionGET /tags获取 Tag 资源集合。
TagApigetTagItemGET /tags/{uuid}检索标签资源。
TagApipostTagCollectionPOST /tags创建标签资源。
TagApiputTagItemPUT /tags/{uuid}替换标签资源。
TokenApipostCredentialsItemPOST /authentication_token获取JWT令牌以登录。

模型

授权

JWT

  • 类型: API密钥
  • API密钥参数名: 授权
  • 位置: HTTP头

测试

要运行测试,请使用

composer install
vendor/bin/phpunit

作者

dev@slis.io

关于此包

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

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