Skip to main content

Microservices - Spring cloud API gateway along with registry server

Here we will learn, how to create API gateway using Spring cloud API. We will also register it with discovery/ registry server. Also will see how to access microservice using registry server through API gateway.

What is API gateway

As its name implies, API gateway is the single entry-point to an application or system. It can handle a request and invoke the appropriate service registered with it. It provides many features like protocol translation, filtering, security, interceptors etc. Using API gateway we can invoke any microservice whether its direct invocation or using some registry/ discovery server to invoke registered services using their ID.

Creating API gateway

In our example we will create an API gateway which will register itself with Eureka discovery server and will invoke the microservice available in discovery server using its registered service ID.
API gateway can be implemented two ways, one is using Zuul proxy and second is using spring cloud API gateway. Difference between them is blocking and non-blocking. Spring cloud API gateway is non-blocking implementation and can support many more requests at same time compare to zuul proxy implementation. In this example I am going to use Spring cloud API gateway for our API gateway implementation.
Below are the required code and configurations.
  • Maven dependencies
  •     <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    
  • Spring boot main class
  • @SpringBootApplication
    public class ApiGatewayApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ApiGatewayApplication.class, args);
        }
    }
    
  • Application configuration
  • Below configuration is registering it with Eureka registry/ discovery server.
    server.port: 9999
    eureka:
      client:
        registerWithEureka: true
        serviceUrl:
          defaultZone: http://localhost:8089/eureka
        healthcheck:
          enabled: true
    
    Below configuration is required to create routes for services registered with discovery server.
    spring.cloud.gateway.discovery.locator.enabled: true
    
    Below configurations define the name for application and a route for our microservice. Here you can see that API gateway doesn't need to know the network location of microservice but it needs registered ID with discovery server. Here we define the predicates to invoke specified services.
    spring:
      application.name: api-gateway
      cloud:
        gateway:
          routes:
          - id: UserManagementService
            uri: lb://USERMANAGEMENTSERVICE
            predicates:
            - Path=/users/**
    
    

Creating Registry/ Discovery server

Please refer below post for discovery server tutorial and source code.

Creating Microservice

Please refer below post for developing microservice and source code.

Running and Testing API gateway

Before starting the API gateway application please make sure that discovery server is up and running. You can run below command to start the API gateway application in project's root directory.
mvn spring-boot:run
Now you can access below URL in browser and you will see the result as given in below screenshot.
URL: http://localhost:9999/users/
service response

Source code

Complete source code is available in below Git location.
https://github.com/thetechnojournals/microservices/tree/master/api-gateway

Comments

Post a comment

Popular Posts

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "property.name" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Asynchronous REST service implementation in Spring boot

In this tutorial we will see how to create an asynchronous REST service endpoint using Spring boot application. Asynchronous service works in a way that it will not block the client request and do the processing in separate thread. When work is complete the response returned to the client so our service will be able to handle more client requests at the same time, compare to synchronous processing model. Let's understand how it is working in synchronous mode. In such server/client application at server side it has a pool of threads which are serving the request. If a request received by a thread then it will be blocked until it send the response back to client. In this case if processing doesn't take much time it will be able to process it quickly and accept other client requests but there could be one situation when all threads are busy and not able to accept the new client requests. To overcome of such problems, asynchronous processing model introduced for REST service

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa. To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only. Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&