API Builder

Overview

From API Builder V4.0.0 onward, you can now create your independent services for containerization and deployment on your container platform of choice.

In this first version, you will be able to install the API Builder CLI, create a new project, and run it from the command line, all without the need to create a user account or host your project on the Axway platform.

API Builder lets you build and deploy a project that is comprised of API endpoints that can be consumed by any client application. An API Builder project is a Node.js application that runs as a service and is comprised of several components. You can either define the components using JavaScript or JSON files placed in specific directories, which are automatically loaded when creating an API Builder instance or programmatically create components after initializing an API Builder instance. For information about the components, see the sections below.

To get started, see the API Builder Getting Started Guide.

Connectors

API Builder Connectors are adapters that allow you to read and write data to and from an external data source, such as  MySQL, or in server memory. You can either add an existing connector to your application or create one to interface with your custom data source.

Models

Models provide a standardized interface for an application that allows client applications to access data. Models are either provided by a connector, reduced from an existing model, or composed of several models (composite models) using a left or an inner join operation.

APIs

API Builder APIs can be automatically generated for all models, but there may be cases where you will want to create your custom API. An API provides a way for a client to access your application, such as GET <SERVER_ADDRESS>/api/users/query, execute custom logic, and internally access the application's models and APIs, then return data to the client application.

Blocks

API Builder Blocks are filters that allow you to pre- or post-process data. Blocks are optional and can be used by either APIs or Models.

Flows

API Builder Flows implement the business logic of your API. Flows are created using the Flow Editor, a rich graphical editor.

Topics

Related Links