Creating a REST API from scratch with OpenAPI 3.0 specifications by using the IBM App Connect Enterprise Toolkit

You can create a REST API from scratch with OpenAPI 3.0 specifications by defining the resources, models, and operations in the OpenAPI editor that is integrated with the IBM® App Connect Enterprise Toolkit.

About this task

You can use the OpenAPI editor to create a REST API from scratch with OpenAPI 3.0 specifications. Alternatively, you can Create a REST API from scratch with Swagger specifications by using the IBM App Connect Enterprise Toolkit.

You can also Create a REST API by importing a Swagger document, or Create a REST API by importing an OpenAPI3 document.

Procedure

To create a REST API by defining the resources, models, and operations, 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 Create a REST API and define resources and operations yourself.
  4. Select OpenAPI3 from the menu.
    The API base path field and the Version field are completed automatically.
  5. To finish creating the REST API, click Finish.
    The REST API Editor for the new REST API opens automatically, but you can edit the generated values. You must now use the OpenAPI editor to define resources, models, and operations, as described in Defining resources, models, and operations in a REST API by using the OpenAPI editor.

Results

The REST API is created.

What to do next

Define the operations in the REST API and then implement them, by completing the steps in the following topics:
  1. Defining resources, models, and operations in a REST API by using the OpenAPI editor
  2. Implementing an operation for REST APIs based on OpenAPI 3.0 documents