This repository will not be updated. The repository will be kept available in read-only mode.
We have similar patterns available for Node.js, Swift, and Java Spring as well!
In this code pattern, you will create a Backend for Frontend (BFF) web service using Java EE MicroProfile running on WebSphere Liberty, matching a RESTful API documented in Swagger.
A BFF can be used to elegantly expose complex backend systems to multiple client-facing platforms, such as iOS and the web, without building a monolothic API that attempts to serve all clients equally. Different types of clients require different types of user experiences, and having a backend API tightly coupled to each specific user experience actually makes for a much more loosely coupled system overall. This pattern helps frontend teams iterate on features faster by giving them more control over the APIs they interact with, without affecting the user experience or development team driving a sister frontend.
When you have completed this code pattern, you will understand how to:
- Build out the Backend for Frontend (BFF) architecture pattern
- Deploy to Kubernetes, Cloud Foundry or a DevOps Pipeline
- Operate an application with monitoring and distributed trace
- Connect to provisioned services
Learn more about the Backend for Frontend pattern in this tech talk:
As an alternative to the steps below, you can create this project as a starter kit on IBM Cloud, which automatically provisions required services, and injects service credentials into a custom fork of this pattern. Then, you can skip directly to step 4 below.
- Maven
- Java 8: Any compliant JVM should work.
- Java 8 JDK from Oracle
- Java 8 JDK from IBM (AIX, Linux, z/OS, IBM i), or Download a Liberty server package that contains the IBM JDK (Windows, Linux)
The application is configured to provide JAX-RS REST capabilities, JNDI, JSON parsing and Contexts and Dependency Injection (CDI).
These capabilities are provided through dependencies in the pom.xml file and Liberty features enabled in the server config file found in src/main/liberty/config/server.xml.
The BFF application has a health endpoint which is accessible at <host>:<port>/javalibertybackendforfrontend/health. The context root is set in the src/main/webapp/WEB-INF/ibm-web-ext.xml file. The ports are set in the pom.xml file and exposed to the CLI in the cli-config.yml file.
The project contains IBM Cloud specific files that are used to deploy the application as part of a IBM Cloud DevOps flow. The .bluemix directory contains files used to define the IBM Cloud toolchain and pipeline for your application. The manifest.yml file specifies the name of your application in IBM Cloud, the timeout value during deployment and which services to bind to.
Credentials are either taken from the VCAP_SERVICES environment variable that IBM Cloud provides or from environment variables passed in by JNDI (see the server config file src/main/liberty/config/server.xml).
To build and run the application:
mvn installmvn liberty:run-server
To run the application in Docker use the Docker file called Dockerfile. If you do not want to install Maven locally you can use Dockerfile-tools to build a container with Maven installed.
The application exposes the following endpoints:
- Health endpoint:
<host>:<port>/<contextRoot>/health - Swagger API:
<host>:<port>/ibm/api/explorer/, you will need to login with the credentials set in yourserver.xmlfile. By default these areguestandpassword.
The context root is set in the src/main/webapp/WEB-INF/ibm-web-ext.xml file. The ports are set in the pom.xml file and exposed to the CLI in the cli-config.yml file.
This code pattern is licensed under the Apache License, Version 2. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 and the Apache License, Version 2.