larskoennel/azubiclient

dev-main 2022-10-26 08:00 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• swagger

README

SwaggerClient-php

For all your azubi data needs!

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // 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()
);
$id = "id_example"; // string | 

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

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // 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()
);
$id = "id_example"; // string | 

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

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // 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()
);

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

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // 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()
);
$id = "id_example"; // string | 
$body = new \Swagger\Client\Model\AzubisIdBody(); // \Swagger\Client\Model\AzubisIdBody | Input data that you want changed.

try {
    $result = $apiInstance->patchAzubisPatchAzubi($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchAzubisPatchAzubi: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // 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()
);
$body = new \Swagger\Client\Model\AzubisBody(); // \Swagger\Client\Model\AzubisBody | Input the azubi data

try {
    $result = $apiInstance->postAzubisPostAzubi($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->postAzubisPostAzubi: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://localhost:8000

Class	Method	HTTP request	Description
DefaultApi	deleteAzubisDeleteAzubi	DELETE /azubis/{id}
DefaultApi	getAzubisGetAzubi	GET /azubis/{id}
DefaultApi	getAzubisGetAzubiList	GET /azubis
DefaultApi	patchAzubisPatchAzubi	PATCH /azubis/{id}
DefaultApi	postAzubisPostAzubi	POST /azubis

Documentation For Models

• Azubi
• AzubisBody
• AzubisIdBody

Documentation For Authorization

All endpoints do not require authorization.

Author