Get OpenAPI description for a non-secure service

Retrieve the OpenAPI description from a non-secure RESTful service using the service URL with the ?openapi.json query string.

A client application needs the OpenAPI description of the RESTful service before generating a stub file or calling the service. For non-secure services, you can retrieve the description directly from the service URL.

  1. Use the service URL with the ?openapi.json query string to retrieve the OpenAPI description.
    
    http://host:port/gas/ws/r/group/xcf/service?openapi.json
    

    The OpenAPI description is displayed in JSON format in your browser. You can save the output to a file if needed.

  2. (Optional) Save the JSON output to a file if you prefer to generate the stub from a local specification.

    You can now generate the stub file using the saved JSON or directly from the service URL. For details, go to Generate a REST stub file.