Skip to main content
Version: ACE 5

Import APIs using API Builder

note

OpenAPI import is intended to generate an ACE client for given specification. It is not intended for import/export functionality. In order to import/export APIs please use workspace import/export feature.

API import overview​

The API Builder allows importing OpenAPI files in both YAML and JSON format and provides a selective overview of the operations that will be imported.

Once an OpenAPI file is selected, the import overview dialog is shown. This dialog contains key information about the incoming operations such as the method, path, and whether it is selected for import.

Import status​

In the status column you can see various statuses, such as whether the operation is Added, Changed or Unchanged.

If an imported operation has the same path and method as an existing operation, it is treated as a match. To decide whether the operation is Changed or Unchanged, the API builder performs two comparisons:

  1. The schemas referenced by the operations are compared. If there are any differences at any level of depth between schemas referenced by both operations, the status is shown as Changed.

  2. The operation fields are compared. If any operation field that supports modification in the API Editor is changed ( ex: Tag, Response description, Parameter and others), the status is shown as Changed. Modifying OpenAPI properties not specified in the API Editor (or adding custom properties) will not be treated as a change within the operation.

Import process​

ACE imports only selected API operations and all schemas which are directly or indirectly referenced by selected API operations.

During import ACE performs following actions:

  • Import operations
  • Imports all referenced schemas
  • Generate flows with predefined steps to call an API operation
    • Flow name is generated either from operation id (if present) or from operation path and verb

Versioned import​

Default import mode is versioned import.

During versioned import ACE adds version information to API path, schemas and generated flows.

Version number for operation/schema is based on largest existing version number found in ACE workspace and might not be the same for all operations/schemas.

Forced version​

By using forced version it's possible to force same version for all imported items.

caution

If there already exists operation/schema/flow with the same name it will be overwritten in forced mode.

Non-versioned import​

If versioning is disabled ACE doesn't add any version information to generated items.

caution

If there already exists operation/schema/flow with the same name it will be overwritten in non-versioned mode.