Skip to content

Instantly share code, notes, and snippets.

@drewbrokke
Created June 11, 2019 22:09
Show Gist options
  • Save drewbrokke/6d2516734580f2a06a910447ef263268 to your computer and use it in GitHub Desktop.
Save drewbrokke/6d2516734580f2a06a910447ef263268 to your computer and use it in GitHub Desktop.
Liferay Headless API Notes

Grow documentation: https://grow.liferay.com/share/Headless+APIs+in+7.2

Headless API Loop posts: Part 1: https://loop.liferay.com/es/home/-/loop/feed/17520934 Part 2: https://loop.liferay.com/es/home/-/loop/feed/17681438 Part 3: https://loop.liferay.com/web/guest/home/-/loop/feed/18262116

Documentation on the search/filter/sort syntax supported by collections: https://github.com/ngaskill/liferay-docs/blob/aaf04beef3ddb75017f054c6d8291493b3d0f755/developer/frameworks/articles/150-web-services/02-headless-apis/08-filter-and-sort.markdown

The base looks like this: localhost:8080/o/headless-admin-user/v1.0

In Gogo shell, see the whole endpoint structure by running: jaxrs:check

See the schema for a domain by hitting: http://localhost:8080/o/headless-admin-user/v1.0/openapi.json

In this case, /headless-admin-user is the domain

curl -u [email protected]:test localhost:8080/o/headless-admin-user/v1.0/organizations

curl -u [email protected]:test localhost:8080/o/headless-admin-user/v1.0/openapi.json

Published API, example - headless-admin: https://app.swaggerhub.com/apis/liferayinc/headless-admin-user/1.0#/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment