Grav Rest Form Plugin

The Rest Form Plugin is an extension of the form plugin of Grav CMS. With this plugin you can save added forms by calling a REST service.

Installation

Installing the Grav Rest Contents plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install grav-rest-contents

This will install the Grav Rest Contents plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/grav-rest-contents.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to grav-rest-contents. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/rest-form

NOTE: This plugin is a modular component for Grav which requires Grav and the Form to operate.

Configuration

Before configuring this plugin, you should copy the user/plugins/grav-rest-contents/grav-rest-contents.yaml to user/config/plugins/grav-rest-contents.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true

Usage

In a form page add the rest action as following:

    process:
       - rest:
            url: http://host:port/resource
            list: array_list_name

where

• url: (mandatory) the url of the resource to call
• list: (optional) the name of the object (array type) that wrapped the object

See this demo page.

Example

Following an example page form.md that invoke a REST service:

    ---
    title: Nuova categoria
    
    form:
        name: insertcategory
        #action: rest
    
        fields:
            - name: name
              label: Name
              placeholder: The object name
              autofocus: on
              autocomplete: on
              type: text
              validate:
                required: true
    
            - name: description
              label: Description
              placeholder: The object escription
              type: text
              validate:
                required: true
    
        buttons:
            - type: submit
              value: Submit
    
        process:
            - rest:
                url: http://lccalhost:8080/res/object
                list: objects
    ---
    
    # Create Object By Rest Service FORM

The submit execute a POST request to uri http://lccalhost:8080/res/object and data:

{ 
  "objects": 
	[
		{
		 "name": "<form name value>",
		 "description": "<form description value>"
		}
	]
}

If rest action don't have list param, the json produced is as following:

{ 
  "name": "<form name value>",
  "description": "<form description value>"
}

To Do

• [1] Complete this documentation
• [2] Create a docker image for test the plugin
• [3] Support other methods (GET, PUT, DELETE)