Fluwiz Documentation

Developer Reference

How-To API

This section provides a step-by-step walkthrough of how to create an API and publish.

  • Search API
  • Save API
  • Delete API
  • Custom Action API
  • Native Query API
  • PalmyraAppScript - The base class for the groovy script

Within Fluwiz, each script is going through pre-defined set of handlers. Each handler shall implement the base class PalmyraAppScript and depends on the request, the methods on the class will be invoked.

To develop the API, you shall write the groovy script extending the PalmyraAppScript with specific naming convention and place under the folder -

appdata/myapp/scripts/api

Depends on the directory structure, the APIs are dynamically constructed and invoked based on the Groovy scrips available in the folder.

The request-response structure can be defined for each api request and shall be specified as json configuration under

appdata/myapp/objects/

If no json structure is provided, The table structure as defined in the database will be considered as the request-response structure.

Fluwiz provides utility APIs to generate default structure based on the database schema. The developer can generate the structure and customize as per the needs.