To view your REST services documentation using the OpenAPI format, use the following URI syntax:
host:port[/webapp_name]/server/rest/services/openapi
For example:
localhost:8810/server/rest/services/openapi
localhost:8810/mywebapp/server/rest/services/openapi

OpenAPI JSON output

The following is sample JSON output:

{
  "openapi": "3.0.3",
  "info": {
    "title": "OpenAPI documentation for REST-based services",
    "description": "",
    "termsOfService": "",
    "contact": {
      "name": "",
      "url": "",
      "email": ""
    },
    "license": {
      "name": "",
      "url": ""
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "{ctx}/rest",
      "description": "Default relative-path configuration",
      "variables": {
        "ctx": {
          "description": "The webapp/context for this service. Empty/blank indicates ROOT",
          "default": ""
        }
      }
    },
    {
      "url": "{scheme}://{host}:{port}{ctx}/rest",
      "description": "Default server configuration",
      "variables": {
        "scheme": {
          "enum": [
            "http",
            "https"
          ],
          "default": "http"
        },
        "host": {
          "default": "localhost"
        },
        "port": {
          "default": "8810"
        },
        "ctx": {
          "description": "The webapp/context for this service. Empty/blank indicates ROOT",
          "default": ""
        }
      }
    }
  ],
  "paths": {
    "/_oepingService/_oeping": {
      "get": {
        "tags": [
          "_oepingService"
        ],
        "summary": "OpenEdge.Rest.Admin.AppServerStatus..ServerStatus",
        "description": "",
        "operationId": "Class:OpenEdge.Rest.Admin.AppServerStatus+ServerStatus",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": "{\"response\":{\"_retVal\":\"string\"}}"
                }
              }
            }
          }
        },
        "security": []
      }
    }
  },
  "components": {
    "schemas": {},
    "securitySchemas": null
  },
  "security": [],
  "tags": [
    {
      "name": "_oepingService",
      "description": "Service for '_oepingService', v1.0.0",
      "externalDocs": null
    }
  ],
  "externalDocs": null
}

The output contains the OpenAPI format along with other standard properties defined by the OpenAPI standard. This includes supporting information such as the HTTP verb expected to access those services, schema information (when applicable), and a list of input and output parameters defined for each service. For parameters, only the expected external (HTTP) datatype is described, as the OpenAPI is a generic descriptor format and is server-language agnostic.

View output graphically in Swagger

Swagger can parse the JSON output in OpenAPI format, allowing you to easily view the REST documentation. Not only can you view, but you can also interact with the API. The following figure shows what the OpenAPI documentation look like in Swagger for REST-based services: