Onboard Connectors

In Xapix, you onboard REST and SOAP connectors using several methods. This includes using OpenAPI files, schema URLs, Xapix internal APIs and HTTP methods/URL address. In this tutorial, we will use a OpenAPI 2.0 Swagger file.

In the following steps, we first download the Quickstart Swagger file and then using the Connectors page we import this file into our project. This onboards four REST connectors:

  • allVariants

  • findEnglineById

  • findModelById

  • findVariantById

Download the REST OpenAPI 2.0 Swagger file

Xapix has provided a Quickstart demo file for use with this tutorial. It is a REST OpenAPI 2.0 Swagger file. Begin by downloading the following swagger file to a local drive, then continue with the next steps.

Import the REST OpenAPI 2.0 Swagger file

Currently, the project does not have any available connectors. So, let's import the Quickstart demo file. We do this using the Connectors page.

On the Connectors page, click REST Connector to import the Quickstart OpenAPI 2.0 file.

Now, let's drop the Quickstart demo file on the import area.

Import the Swagger file

Once the import is successfully completed, a confirmation dialog appears. Any schema validation issues are provided.

Data sources successfully onbarded

The Connectors page shows the new connectors you can use for the Quickstart tutorial.

Step

Description

1

From the Home menu, click Connectors.

2

From the Connectors page, click REST Connectors.

3

Click the Import icon and browse to the swagger file we downloaded previously. Then import the file into your project by clicking Open.

4

Xapix validates the schema file and if no validation errors were identified, you should see the message Schema was successfully imported.

5

The onboarded connectors now appear on the Connectors page.

Next step
Next step

To continue, see Create a REST endpoint.

See also: Connectors‚Äč