Generating an OpenAPI representation
OpenAPI is a standardized version of the Swagger specification. It provides a language-independent way to present REST APIs. You can generate OpenAPI representations for executing decision services. This capability is part of ODM Decision Connect, which enables reusable decisions to be exposed as OpenAPI based public APIs to be invoked directly by applications. The OpenAPI-based decisions can also be published to an IBM API Connect catalog for managed APIs. IBM API Connect Essentials is also an optional part of Decision Connect.
Before you begin
Before you can use the REST service in a client, you must start the sample server or configure Rule Execution Server for your application server. See Starting and stopping the sample server or Configuring.
About this task
To write JSON input for the POST method to a specific ruleset endpoint URI, you can generate the OpenAPI representation. The OpenAPI representation contains one entry for the POST method.
Procedure
Results
You generated an OpenAPI representation in YAML or JSON format.
- If you sent the request from a browser, an HTML page displays the error message.Note: The status code is 200 despite the error message because it applies to the HTML page, not to the request result.
- If you sent the request from a client other than a browser, a status code 404 (Not Found) is returned and the error is described in XML.