Top Method Summary
Options Name Purpose
GenerateHtml (character, character, IHttpResponse, ISwaggerRestEntitiesGenerator) Generate html page displaying all BusinessServices found in Package
GenerateJson (character, character, IHttpResponse, ISwaggerRestEntitiesGenerator) Generates an OpenAPI document
GenerateYaml (character, character, IHttpResponse, ISwaggerRestEntitiesGenerator) Generates an OpenAPI document in YAML format Notes : Reuses the JSON generation/caching pipeline and converts the cached JsonObject to YAML via YamlConverter @param pcRequestUri The URI of the request @param pcViewName The Swagger view to present @param poResponse The Response to the client requesting the information @param poSwagger The Swagger generator */
Progress.Json.ObjectModel.JsonObject GetSwaggerDocument (character, character, ISwaggerRestEntitiesGenerator) Returns the OpenAPI document as a JsonObject, using the in-memory cache when CacheSwaggerFile is enabled Notes : The JSON representation is the canonical cached form; YAML output is derived from this JsonObject on demand @param pcRequestUri The URI of the request @param pcViewName The Swagger view to present @param poSwagger The Swagger generator @return The Swagger/OpenAPI document as a JsonObject */
INTEGER HandleGet (IWebRequest) Handles the http GET operation

Top Property Summary
Options Name Purpose
LOGICAL CacheSwaggerFile


Method Detail
Top

GenerateHtml (character, character, IHttpResponse, ISwaggerRestEntitiesGenerator)

Purpose: Generate html page displaying all BusinessServices found in Package
Notes:

Parameters:
pcRequestUri CHARACTER
The URI
pcViewName CHARACTER
The view name
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response to the client requesting the information
poSwagger Consultingwerk.OERA.Swagger.ISwaggerRestEntitiesGenerator
The Swagger generator
Top

GenerateJson (character, character, IHttpResponse, ISwaggerRestEntitiesGenerator)

Purpose: Generates an OpenAPI document
Notes:

Parameters:
pcRequestUri CHARACTER
The URI of the request
pcViewName CHARACTER
The Swagger view to present
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response to the client requesting the information
poSwagger Consultingwerk.OERA.Swagger.ISwaggerRestEntitiesGenerator
The Swagger generator
Top

GenerateYaml (character, character, IHttpResponse, ISwaggerRestEntitiesGenerator)

Purpose: Generates an OpenAPI document in YAML format
Notes : Reuses the JSON generation/caching pipeline and converts
the cached JsonObject to YAML via YamlConverter

Parameters:
pcRequestUri CHARACTER
The URI of the request
pcViewName CHARACTER
The Swagger view to present
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response to the client requesting the information
poSwagger Consultingwerk.OERA.Swagger.ISwaggerRestEntitiesGenerator
The Swagger generator
Top

Progress.Json.ObjectModel.JsonObject GetSwaggerDocument (character, character, ISwaggerRestEntitiesGenerator)

Purpose: Returns the OpenAPI document as a JsonObject, using the in-memory
cache when CacheSwaggerFile is enabled
Notes : The JSON representation is the canonical cached form; YAML output
is derived from this JsonObject on demand

Parameters:
pcRequestUri CHARACTER
The URI of the request
pcViewName CHARACTER
The Swagger view to present
poSwagger Consultingwerk.OERA.Swagger.ISwaggerRestEntitiesGenerator
The Swagger generator
Returns Progress.Json.ObjectModel.JsonObject
The Swagger/OpenAPI document as a JsonObject
Top

INTEGER HandleGet (IWebRequest)

Purpose: Handles the http GET operation
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The IWebRequest
Returns INTEGER
The http response code


Property Detail
Top

LOGICAL CacheSwaggerFile


Returns LOGICAL


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       03.05.2026 21:38:56