Add an API Service

Learn how to create an API service asset on your environment.

2 minute read

Add an API service

Follow these steps to create an API service in your environment:

  1. From the details page of your environment, click the plus (+) button located at the top right of the Activity Dashboard section.
  2. Click Upload a file or Fetch from URL to define the API specification.
  3. Confirm the information about your API service:
    • Title: Enter a descriptive name. The title is searchable, but it does not need to be unique.
    • Logical Name: Enter an ID for the service. The ID must be unique within the scope of the environment. The logical name is referenced in any dependencies of the API service.
    • Description: Limited to 1000 characters.
    • Tags: Used to group assets, making it easier and faster to find them.
    • Attributes: Key and value pairs used for extending functionality and integrations with third-party systems.
    • API Service Image: A visual aid when looking through the list of API services.
  4. Click Save.

To learn how to add an API service using the Axway Central CLI, see Build and manage API services in your environments.

Import an API service specification

You can define the API service specification by uploading a file or by fetching the specification from a URL.

The following table shows the accepted file extensions listed by accepted file type versus service specification type:

OAS2 OAS3 Protobuf WSDL
File Type Expected Supported Expected Supported Expected Supported Expected Supported
.json YES YES YES YES NO NO NO NO
.yml/yaml YES NO YES NO NO NO NO NO
.wsdl NO NO NO NO NO NO YES YES
.proto NO NO NO NO YES YES NO NO
.xml NO NO NO NO NO NO NO YES

You can assign any uploaded specification file as an unstructured specification type. This is useful if your specification type is not officially supported.

On upload, the file is automatically parsed and the recommended Specification Type is set. Optionally, if the recommended specification type is incorrect, you can override the selection by choosing a different specification type.

Errors and debugging

In the event of an error while saving the API service, the form page will show an error box explaining what caused the error. The error may contain references to objects only found when using the CLI or API directly. In this case, please refer to the Axway CLI documentation.