Creating a REST API from an imported OpenAPI 3.0 document

To create a REST API in IBM® App Connect Enterprise, you can import an OpenAPI 3.0 document by using the IBM App Connect Enterprise Toolkit.

Before you begin

Create an OpenAPI 3.0 document that describes the resources and operations that you want in the REST API. Ensure that the OpenAPI 3.0 document adheres to the guidelines in the OpenAPI 3.0 specification, and that it satisfies the requirements of IBM App Connect Enterprise. For more information, see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md and Restrictions on OpenAPI 3.0 documents.

About this task

To create a REST API in IBM App Connect Enterprise, you can use the Create a REST API wizard in the IBM App Connect Enterprise Toolkit to import an OpenAPI 3.0 document. You must then create the REST API and other project artifacts that are required to implement and deploy the new REST API. Alternatively, you can create a REST API by defining the models, resources, and operations from scratch, as described in Creating a REST API from scratch with OpenAPI 3.0 specifications by using the IBM App Connect Enterprise Toolkit.

Procedure

To create a REST API by importing an OpenAPI 3.0 document, complete the following steps:

  1. Open the Create a REST API wizard by clicking File > New > REST API .
  2. Enter a name for the REST API.
    The name that you specify is used as the name of the project in the IBM App Connect Enterprise Toolkit.
  3. Select Import resources and operations defined in a RESTAPI document and then click Next.
  4. Click Next.
  5. Select the path to the OpenAPI 3.0 document that describes the resources and operations that you want in the REST API.
    You can import the OpenAPI 3.0 document from the file system or from an existing project in the workspace.
    The file is validated for use in a REST API. If any errors are found while the selected OpenAPI 3.0 document is validated, those validation errors are displayed at the top of the wizard. You cannot proceed if validation errors are found in the selected OpenAPI 3.0 document.
  6. Optional: To review the list of resources and operations that are contained in the selected OpenAPI 3.0 document, click Next.
  7. To finish creating the REST API, click Finish.
    The REST API Description for the new REST API opens automatically, which you can use to implement operations as described in Implementing an operation for REST APIs based on OpenAPI 3.0 documents.

Results

The REST API is created.

What to do next

Implement each of the operations in the REST API as a subflow, see Implementing an operation for REST APIs based on OpenAPI 3.0 documents.