PHPackages                             alanaktion/magento2-swagger-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. alanaktion/magento2-swagger-api

AbandonedArchivedLibrary[API Development](/categories/api)

alanaktion/magento2-swagger-api
===============================

v0.0.1(6y ago)261proprietaryPHPPHP >=5.5

Since Jan 21Pushed 6y ago1 watchersCompare

[ Source](https://github.com/Alanaktion/magento2-swagger-api)[ Packagist](https://packagist.org/packages/alanaktion/magento2-swagger-api)[ Docs](http://swagger.io)[ RSS](/packages/alanaktion-magento2-swagger-api/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (4)Versions (2)Used By (0)

SwaggerClient-php
=================

[](#swaggerclient-php)

Magento 2 REST API (generated by Swagger Codegen )

This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 2.3
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Generating/using this wrapper
-----------------------------

[](#generatingusing-this-wrapper)

You can generate this wrapper yourself with the included `generate.sh` file. If you want to use this one as-is, it's available [via composer](https://packagist.org/packages/alanaktion/magento2-swagger-api):

```
composer require alanaktion/magento2-swagger-api

```

Limitations
-----------

[](#limitations)

Due to how Magento 2 handles its URL parameters, this wrapper is not likely useful for anything beyond a reference implementation of some of the endpoints. Things like the search API use complex dynamic parameters that cannot be auto-generated correctly, making them unusable in this wrapper. I don't plan on manually modifying this wrapper in any way to improve compatibility or add features, but you are welcome to fork the repo if you want to try it yourself.

Due to these limitations, I'm most likely not going to update this at any point, and the repository will be archived unless that changes.

Requirements
------------

[](#requirements)

PHP 5.5 and later

Installation & Usage
------------------------

[](#installation--usage)

### Composer

[](#composer)

To install the bindings via [Composer](http://getcomposer.org/), 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

[](#manual-installation)

Download the files and include `autoload.php`:

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

Tests
-----

[](#tests)

To run the unit tests:

```
composer install
./vendor/bin/phpunit

```

Getting Started
---------------

[](#getting-started)

Please follow the [installation procedure](#installation--usage) and then run the following:

```