Maintaining OpenAPI Objects

The OpenAPI Import Wizard enables you to import an OpenAPI specification into JADE, generating proxy classes based on the OpenAPI specification as subclasses of the JadeRestProxy class. These proxy classes have properties and methods derived from the imported specification and the methods of these classes use the JadeRestClient, JadeRestRequest, and JadeRestResponse classes to make the appropriate request and deserialize the result.

By default, names for the proxy classes are as close as possible to those in the OpenAPI specification. However, you can modify them during the import process; for example, to add prefixes or rename imported classes that clash with the names of user classes or classes from other imported OpenAPI specifications.

When the OpenAPI sheet of the External Components Browser has focus, the Components menu OpenAPI submenu provides the commands listed in the following table that enable you to the maintain the proxy classes generated from OpenAPI specifications.

Menu Command	For details, see …	Action
Import	Importing OpenAPI Specifications	Displays the OpenAPI Import Wizard, which enables you to import an OpenAPI specification (accessed by selecting the OpenAPI submenu command)
Remove	Removing an OpenAPI Specification	Removes the OpenAPI specification selected in the External Components Browser

For details about the actions that you can perform from the OpenAPI sheet of the External Components Browser, see the following subsections.

2020.0.01 and higher

From JADE 2020.0.02, you can create an OpenAPI specification from JADE REST APIs. For details, see "Generating OpenAPI Specifications from JADE REST APIs", in Chapter 11 of the JADE Developer's Reference.