Get the OpenAPI service description

Retrieve the OpenAPI description for a RESTful web service in JSON or YAML.

OpenAPI provides a standardized model for describing RESTful web services. You can retrieve the description directly from the service URL when the service supports OpenAPI.

If you have set a default version in the information record, there is no need to specify the version in the query string in the URI. For example, with http://myhost/gas/ws/r/myGroup/myXcf/myService?openapi.json the GWS generates documentation for the version of operations set as default.

The web service must be running on the Genero Application Server to provide the output.

Retrieve the OpenAPI description in JSON or YAML.

  • To retrieve the description in JSON, append ?openapi.json to the service URL:

    http://myServer:myPort/gas/ws/r/myXcf/myService?openapi.json

  • To retrieve the description in YAML, append ?openapi.yaml to the service URL:

    http://myServer:myPort/gas/ws/r/myXcf/myService?openapi.yaml

    Warning:

    The YAML output feature is experimental and may change.

The OpenAPI description provides details about the operations defined in the web service. For more information, go to Understanding the OpenAPI description of a Genero RESTful service and How GWS maps BDL types into the OpenAPI description.