Build Guzzle service descriptions from Swagger compliant APIs
PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
src
tests
.gitignore
LICENSE
README.md
apigen.yml
composer.json
phpunit.xml.dist

README.md

Swizzle

Build Guzzle service descriptions from Swagger compliant APIs.

What?

  • Guzzle is a framework for building HTTP clients in PHP.
  • Swagger is a specification for describing RESTful services.

Although Guzzle's service descriptions are heavily inspiried by the Swagger spec, they are different enough that we need something to bridge the divide.

Swizzle crawls JSON Swagger docs (such as ours) and transforms it into a Guzzle service description for output into your client code.

Installation

Installation is via Composer.

Add the latest stable version of loco/swizzle to your project's composer.json file as follows:

{
  "require": {
    "loco/swizzle": "~2.0"
  }
}

If you want to install straight from Github you'll have to write your own autoloader for now.

Usage

Basic usage is to configure, build and export - as follows:

$service = new Loco\Utils\Swizzle\Swizzle( 'foo', 'Foo API' );
$service->build('http://foo.bar/path/to/swagger/docs/');
// Serialize Guzzle service config to json
$json = $service->toJson();
file_put_contents('/path/to/config.json', $builder->toJson());
// Now use saved config.json in your project/library to create Guzzle service.

More advanced usage includes registering custom Guzzle classes for commands and responses. See example directory for fuller, working examples.

Build the PHP API documentation with apigen using apigen -c apigen.yml

Limitations

This version was developed very quickly for our own API specifically. That means it's not guaranteed to support the whole Swagger spec.

This library supports only version 1.2 of Swagger spec.