REST Builder Plugin

The REST Builder plugin lets you generate a REST layer defined in the REST Builder rest-config.yaml and rest-openapi.yaml files.


To use the plugin, include it in your project’s root pom.xml file:


You can view an example POM containing the REST Builder configuration here.


The plugin adds one Maven goal to your project:

rest-builder:buildRuns the Liferay REST Builder.

Available Parameters

You can set the following parameters in the <configuration> section of the POM:

Parameter NameTypeDefault ValueDescription
copyrightFileFilenullThe file that contains the copyright header.
restConfigDirFile${project.projectDir}The directory that contains the rest-config.yaml and rest-openapi.yaml files.
« Lang Builder PluginService Builder Plugin »