arthurkirkosa/guzzle-description-loader

Load guzzle service description from various file formats

Maintainers

Details

github.com/arthurkirkosa/guzzle-description-loader

Source

Installs: 192 481

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 16

0.0.7 2020-11-20 21:18 UTC

Requires

MIT fa256f4be7c32974505ee356dca2949451959e54

  • Gordon Franke <info.woop@nevalon.de>
  • Community

This package is auto-updated.

Last update: 2024-12-21 06:09:04 UTC

README

Build Status Dependency Status

Guzzle Service Description Loader

A stand-alone Service Description loader for Guzzle 5.x.

Installation

If you are using Composer, and you should, just run the following command:

composer require "gimler/guzzle-description-loader"

Supported File Formats

  • Yaml
  • Php
  • Json

Usage

use Guzzle\Service\Loader\JsonLoader;
use GuzzleHttp\Command\Guzzle\Description;
use Symfony\Component\Config\FileLocator;

$configDirectories = array(DESCRIPTION_PATH);
$this->locator = new FileLocator($configDirectories);

$this->jsonLoader = new JsonLoader($this->locator);

$description = $this->jsonLoader->load($this->locator->locate('description.json'));
$description = new Description($description);

Sample

{
  "operations": {
    "certificates.list": {
      "httpMethod": "GET",
      "uri": "certificates",
      "description": "Lists and returns basic information about all of the management certificates associated with the specified subscription.",
      "responseModel": "CertificateList"
    }
  },
  "models": {
    "CertificateList": {
      "type": "array",
      "name": "certificates",
      "sentAs": "SubscriptionCertificate",
      "location": "xml",
      "items": {
        "type": "object"
      }
    }
  },
  "imports": [
    "description_import.json"
  ]
}