Skip to content

lfrsales/api-gui

Repository files navigation

Liferay API GUI

A GUI for exploring Liferay's API's in Liferay DXP 7.3.

Usage

Find the widget in the Control Panel under System > API GUI.

API GUI

View results of API requests.

API GUI Result

See example API Calls using Liferay.Util.fetch.

javascriptExample

Explore available schemas.

API GUI Result

How to Build and Deploy to Liferay

Update ./gradle-local.properties so that it contains:

liferay.workspace.home.dir=/path/to/liferay/home

Build it

$ blade gw build

Deploy to Liferay

$ blade gw deploy

Issues & Questions Welcome

Contributing Guidelines

Pull requests welcome.

Releasing

Releases are handled using Github actions.

To release a new version do the following:

  1. Create a git tag.

    1. git tag v0.0.1
  2. Push the tag to Github.

    1. git push origin v0.0.1

The Github action will be triggered and will attach all assets to the release.