Importing OpenAPI Specifications
The selection phase of the OpenAPI Import Wizard enables you to specify appropriate Jade names for the items being imported.
When generating REST API proxy classes based on an OpenAPI specification:
-
The import process generates proxy classes to represent the data model described in the OpenAPI specification as closely as possible, along with any required collection classes.
-
Re-importing an OpenAPI specification deletes entities that are no longer defined in the specification.
-
When an assembly is re‑imported and the previous import used a different data model or if any resource operations have been removed or changed, you may need to change your existing Jade logic.
When you have imported the OpenAPI specification, Jade classes, methods, properties, and constants are generated for the items selected from the specification. For details about the abstract grouping class names, see "
The OpenAPI Import Wizard is a wizard‑style dialog that consists of five steps, each represented by a sheet of the dialog. Use the Next > and < Back buttons to navigate forwards or backwards through the steps. Other than the first and last steps, each step provides default values that enable you to move to the next step.
OpenAPI objects are generated as subclasses of the
Some generated objects may have no properties or fewer properties than expected. This can be because the properties were not defined in the imported OpenAPI specification. If the missing properties are supplied in the response JSON text when you use your OpenAPI client, they are included in the
To import an OpenAPI specification
-
Select the OpenAPI command from the Components menu. The OpenAPI submenu is then displayed.
-
Select the Import command from the OpenAPI submenu of the Components menu or right‑click on the OpenAPI sheet and then select the Import command from the context (popup) menu.
The OpenAPI Import Wizard, which is then displayed, systematically guides you through the import process. When all of the information has been gathered, the wizard generates all of the required classes, properties, and methods that you need to access the REST API from Jade.
2020.0.01 and higher
