fglrestful

The fglrestful tool produces REST web services stub files for client programs.

Syntax

fglrestful [ options ] service
  1. options are described in Options.
  2. service is the service definition file or URL.

Options

Table 1. fglrestful Options
Options Description
-o file Specify a name for the output file.
-prefix <prefix> Add a prefix for constant and variables of the generated web service functions.
-binary <byte|file> Generates binary as BYTE or file name.
-format <xml|json> Specify the preferred REST format (XML or JSON).
-oauth <yes|no| openapi> Generates OAuth support, default is openapi.
Table 2. XML Options
Options Description
-xmloptional <yes|no> Generate XMLOptional attribute (default: no)

Usage

The fglrestful command line tool supports OpenApi version 3. If your REST service is written with Genero REST high-level API, a specification file is provided by default via the query string ?openapi.json or ?openapi.yaml.

You use the tool to generate the GWS client stubs from an OpenApi specification file (JSON format) in order to interact with the REST service.

To access a remote web service, you must get the REST information from the service provider. If the server supports the OpenAPI specification, the fglrestful command can generate the description.