Swagger is an API Tooling Framework based on the OpenAPI Specification (OAS), and can be used to provide a standard (language-agnostic) interface to REST API’s. Thus, providing the capability to understand and realize the capabilities of exposed Service API’s, without the need to understand or have access to the relevant code base.
The Swagger Petstore, is a working example of how the structure is defined and on how the consumer can interact with the service.
Swagger Template File Configuration
To avoid fixed / hardwired configuration issues, the Swagger Generation relies on a template file to provide necessary header information (author, description, etc.). The template file is named as “Swaggerfile.json” and should be located within the directory “Consultingwerk/Templates/BusinessEntityDesigner/Swagger”.
As the Swagger Web Service cannot rely on the Business Entity Designer configuration for the template path (a Unix AppServer will not have access to the Business Entity Designer code base), we have introduced a new setting in the .restapplicaitonsetting files to point to the template folder to allow for customizations: