Package Exports

@loopback/apiconnect
@loopback/apiconnect/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@loopback/apiconnect) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@loopback/apiconnect

This module extends LoopBack with the ability to integrate with IBM API Connect. It comes with an ApiConnectComponent that adds an OASEnhencer extension to contribute x-ibm-configuration to the OpenAPI spec generated by LoopBack applications.

Stability: ⚠️Experimental⚠️

Experimental packages provide early access to advanced or experimental functionality to get community feedback. Such modules are published to npm using 0.x.y versions. Their APIs and functionality may be subject to breaking changes in future releases.

Installation

npm i @loopback/apiconnect --save

Usage

The component should be loaded in the constructor of your custom Application class.

Start by importing the component class:

import {ApiConnectComponent} from '@loopback/apiconnect';

In the constructor, add the component to your application:

this.component(ApiConnectComponent);

The component requires a configuration for API Connect extension for OpenAPI spec. The targetUrl tells API Connect gateway where the REST APIs are served.

const apiConnectOptions: ApiConnectSpecOptions = {
  targetUrl: 'http://localhost:3000/test-service',
};
app
  .configure(ApiConnectBindings.API_CONNECT_SPEC_ENHANCER)
  .to(apiConnectOptions);

Contributions

Tests

Run npm test from the root folder.

Contributors

See all contributors.

License

MIT