Skip to end of metadata
Go to start of metadata

Introduction

Beginning with API Builder V3.0.0 (Included in CLI 7.0.0), you can manage endpoints and their associated flows using the API Builder Console. You can also create and edit flows and configure their associated flow-nodes using the API Orchestration user interface.

Manage endpoints

An API endpoint provides a way for a client to access your application, such as GET <SERVER_ADDRESS>/api/users/query and access the application's models and/or custom code blocks to return data back to the client application. You can use the API Builder Console to import, generate, export, and delete endpoints. For additional information, refer to Manage Endpoints.

Flow orchestration

Flows can be viewed and edited on the API Orchestration user interface. Additionally, you can manage flow-node configuration and connections on the API Orchestration user interface. For additional information on the API Orchestration user interface and for flow-node configuration reference information, refer to Flow Orchestration.

Manage flows

Flows are acyclic directed graphs of operational flow-nodes which are composed of inputs, logic, and outputs. They are used by endpoints, which require them for their runtime functionality of taking inputs and turning them into responses when an endpoint is hit. You can use the API Builder Console and the associated API Orchestration user interface to view, create and edit flows. For additional information, refer to Manage Flows.

Manage nodes

Flow-nodes represent an individual portion of functionality in a flow. You can use the API Orchestration user interface to add, configure, and delete flow-nodes. You can also connect and disconnect flow-nodes in a flow. For additional information, refer to Manage Nodes.

Axway Flow SDK

The Axway Flow SDK (axway-flow-sdk) is a standalone utility that enables the creation of custom flow-nodes for API Builder flows. For additional information, refer to Axway Flow SDK.

  • No labels