Working with API definitions

An API definition specifies the complete configuration for an API. You can create and configure your APIs by using either the API Designer UI application, or by using the browser based API Manager UI.

If you are working with APIs that conform to the OpenAPI Specification, note that API Connect uses the following terms:
  • OpenAPI Specification:

    The OpenAPI Specification defines a standard, language-agnostic interface to RESTful APIs. API Connect supports version 2 and version 3 of the OpenAPI Specification.

  • OpenAPI document:

    One or more files that describe an API conforming to the OpenAPI Specification.

  • OpenAPI definition:

    The description of an API that conforms to the OpenAPI Specification. In API Connect, you can create the API definition by filling in settings and properties, or by importing an OpenAPI document that contains an API definition that you want to work with.

The following topics provide full details for creating and configuring your APIs.