It’s important for apps on different machines to communicate. To enable this, an app can expose APIs so remote components (other apps or devices) can access the app’s features. For example, one service could have a client app presenting information to users, a server app processing data in B2B setting, and an IoT device requesting data to do its work. Exposing web APIs lets external applications or devices communicate with yours.

Because Liferay Portal contains so many apps and features, it’s prudent for Liferay to let developers access those apps and features from external apps and devices by exposing their APIs. Additionally, Liferay’s development platform makes it easy to extend them and create new ones.

There are two different approaches for clients to connect to Liferay Portal’s web APIs:

  • Hypermedia REST APIs (beta): These services are designed and built in an opinionated way, and thus decoupled from the internal model. They follow well-known industry standards and allow evolution of the APIs without breaking clients. This is the modern, preferred way to work with web services in Liferay Portal.

  • Plain Web/REST Services: This is the old way to build and consume web services in Liferay Portal, but is still supported. For example, you can use JAX-RS, JAX-WS, or Service Builder to implement plain REST or SOAP web services.

The tutorials that follow show you how to consume and create web services in Liferay Portal, beginning with hypermedia REST APIs.

Why Hypermedia REST APIs?

Hypermedia is hypertext (the H in HTML) extended to other media, like images, audio, video, or links. This isn’t a new concept. When a browser requests a web page, it retrieves an HTML document...


Foundations: JAX-RS, OSGi Whiteboard, and APIO

Hypermedia REST APIs in Liferay Portal are built on these technologies: JAX-RS OSGi’s JAX-RS Whiteboard Specification APIO Architect You don’t need a detailed understanding of these, but you should...


Enabling Hypermedia REST APIs

Liferay’s Hypermedia REST APIs are an implementation of Apio Architect, which is pre-installed Liferay Portal. Apio Architect is a server-side library that facilitates the creation of Apio REST...


Consuming Web Services

Client apps can’t work without web services to consume. Since Liferay Portal’s web services are implemented via hypermedia REST APIs, developers can discover and traverse the APIs using the...


Service Builder Web Services

Service Builder can generate local and remote services for your Liferay apps. The section of tutorials on Service Builder gives a general introduction to Service Builder, as well as instructions on...



You can deploy JAX-RS and JAX-WS web services and consume them much as you would outside of Liferay Portal. There are, however, a few things you should know, particularly with regard to deploying...

+1 (1 Stimme)
Service Access Policies Zurück