The OpenAPI Specification (OAS) defines a standard interface description for REST APIs. This enables you to understand a service without accessing source code, additional documentation, or inspection of network traffic.
OAS is also known as Swagger Specification. Following are the versions and formats supported by ePortal:
Versions: Version 2.0 and 3.0
Formats: .JSON and .YAML
Notes:
For more information on the OAS Specification and COBOL copy books, refer to Generating COBOL Copy Books and COBOL OpenAPI Extensions.
While importing multiple OpenAPI specifications, ensure that Namespace is different for each specification.
To import an OpenAPI specification, perform the following steps:
Do any one of the following:
In Solution Explorer, right click the project name, and click Import OpenAPI Specification.
On the Project menu, click Import OpenAPI Specification.
The Import OpenAPI Specification dialog box appears.
In the Import OpenAPI Specification dialog box, provide the following details to import the OpenAPI Specification:
Under Metadata File, you can do any one of the following to select a metadata file:
Select an existing Swagger metadata file by clicking Browse….
Select a Swagger URL by copying the link of the OpenAPI Specification.
In NameSpace, change the name if required.
The file name is the default value.
From the COBOL Language list, select any one of the following language:
MCP COBOL 85: To call the service using the MCP back-end server.
OS 2200 UCOBOL: To call the service using the OS 2200 back-end server.
Click OK.
The artifacts are generated under particular folders in the project.