@commerce-apps/exchange-connector

Downloads raml specs from exchange

Usage no npm install needed!

<script type="module">
  import commerceAppsExchangeConnector from 'https://cdn.skypack.dev/@commerce-apps/exchange-connector';
</script>

README

exchange-connector

The exchange-connector package allows downloading RAML files from anypoint exchange.

Setup

Execute the following commands to install dependencies and build exchange-connector.

# To setup
npm install

# To build
npm run build

# To link (Optional)
npm link

Usage

import {getBearer, getRamlByTag} form "@commerce-apps/exchange-connector"

// Gets an Access token for talking with Mulesoft
getBearer(username, password): Promise<Token>

// Searches and returns the list of available RestApis
searchExchange(accessToken: string, searchString: string): Promise<RestApi[]>

// Gets raml from exchange, downloads to specified folder (defaults to ./download )
downloadRestApi(restApi: RestApi, destinationFolder: string): Promise<void | Response>

Testing

To run tests, execute

npm run test

To print the detailed test results and errors on the console, execute

npm run test:debug

License Information

This package is licensed under BSD-3-Clause license. See the license for details.