Information needed to generate a REST stub file

You need the OpenAPI description of the RESTful service before generating the stub file or implementing client-side calls.

Before coding a RESTful client application, ensure that you have the OpenAPI description for the service you intend to call. The description defines the available operations, the required parameters, and the data structures used for request and response bodies. This information is essential for generating the REST stub file and for understanding how to implement the client-side logic.

You can retrieve the OpenAPI description directly from the service URL or by using the fglrestful tool included with the Genero Web Services package. The retrieved description becomes the input to the stub-generation process.

If the service is secured, authentication may be required before accessing the OpenAPI description. For details, go to Get OpenAPI description for a secure service.

Some services publish multiple API versions. Use the version that matches the service you intend to call, as the stub file generated from the OpenAPI description must correspond to the version deployed on the server.