Defining a REST Service Application

The REST services application is defined from the Define Application dialog in the standard way. For more details, see "Defining Applications", in Chapter 3 of the Development Environment User's Guide.

On the Application sheet, select Rest Services or Rest Services, Non-Gui as the Application Type.

On the Web Options sheet, select your JadeRestService subclass and specify the required IIS connection information.

The ISO 8601 format functionality is displayed on the Web Options sheet of the dialog only when the application selected in the Application Type list box on the Application sheet of this dialog is Rest Services or Rest Services, Non‑Gui. For details, see "ISO 8601 Date and Time Support", elsewhere in this chapter.

From version 2018.0.01, the Exclude Protected Properties check box enables you to specify whether the application definition includes or excludes protected properties from serialization and object construction. When this check box is:

The setting of this check box is loaded when the REST service is initiated, and any change to the check box setting does not take effect until the REST service application is restarted.

Read‑only properties are always excluded from object construction from the received XML or JSON data.

The generated description includes only the classes and the superclasses referenced by the specified parameter values and return types of the communications methods of the JadeRestService subclass selected for the application. Note, however, that no class description is included if those methods return only Any or a primitive type.

In the jadehttp.ini file, add an [application‑name] section to enable clients to connect to the Jade REST services application. Set the parameter values to match the configuration information you specified on the Define Application dialog.

[RestApp]
ApplicationType=RestServices
TcpConnection=localhost
TcpPort=45000

For more details about configuring jadehttp for remote connections, see "[application-name] Section", in Chapter 2 of the Installation and Configuration Guide. For details about generating an OpenAPI specifications from version 2020.0.02, see "Generating OpenAPI Specifications from Jade REST APIs", later in this chapter.