netzkollektiv/node-magento2-swagger

Magento 2 REST API Client generated from Swagger specification

Magento 2 REST API client automatically generated from Swagger specification

Magento 2 implements Swagger providing a JSON Schema of the REST endpoints, this package compiles the JSON into classes and methods using templates (see inside the templates/ directory) for consuming the API in a NodeJS applicaton.

Installation

npm install magento2-swagger --save

Example usage

A full specification of all the endpoints in this packages can be found in the Magento 2 Dev Docs

var magentoSwagger = require('magento2-swagger').Magento;

var magento = new magentoSwagger('http://www.example.com/rest');

magento.catalogCategoryManagementV1GetTreeGet().done(function (response) {
  console.log(response.body);
});

Authenticated Example

The authenticated example also provides the API with a Authorization Bearer header (token value).

var magento = new magentoSwagger({
    domain: 'http://example.com/index.php/rest',
    token: {
        value: token
    }
});

magento.customerCustomerRepositoryV1GetByIdGet()
    .catch(function(err) {
        console.log(err);
    })
    .done(function(response){
        console.log(response.body);
    });

See complete example of usage and authorization in examples/customer.js.