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>
  • Spring boot main class
  • @SpringBootApplication
    public class ApiGatewayApplication {
        public static void main(String[] args) {
  , args);
  • Application configuration
  • Below configuration is registering it with Eureka registry/ discovery server.
    server.port: 9999
        registerWithEureka: true
          defaultZone: http://localhost:8089/eureka
          enabled: true
    Below configuration is required to create routes for services registered with discovery server. 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: api-gateway
          - id: UserManagementService
            uri: lb://USERMANAGEMENTSERVICE
            - 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.


  1. This is an amazing blog, thank you so much for sharing such valuable information with us.
    Microservices Online Training
    Microservices Training in Hyderabad

  2. It is quite helpful that you have offered this information on your blog. We sincerely appreciate the effort you put into your article, and it helps us, too. Thank you for sharing this information.hire laravel developers

  3. A very thorough article about.....has been supplied by you. It's a great article for me and for those who...... We appreciate you sharing this knowledge with us.electronic signature


Post a Comment

Popular Posts

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=&

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 "" 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

Spring Batch tutorial with example

Spring batch is used to create and process the batch jobs. It provides various features like logging, job statistics, transaction management, restarting jobs. It is very helpful in processing of large dataset but with finite volume of data. In this tutorial we will learn how to create and execute the spring batch job. In our example we will create a job which will import all the words from a text file to database and then at last it will print the total number of words available in the database. Below is the project structure. Creating batch job Sample text file to import Below is the contents of text file which we use for importing the words. The list below gives you the 1000 most frequently used English words in alphabetical order. Once you've mastered the shorter vocabulary lists, this is the next step. It would take time to learn the entire list from scratch, but you are probably already familiar with some of these words. Feel free to copy this list into

Multiple data source with Spring boot, batch and cloud task

Here we will see how we can configure different datasource for application and batch. By default, Spring batch stores the job details and execution details in database. If separate data source is not configured for spring batch then it will use the available data source in your application if configured and create batch related tables there. Which may be the unwanted burden on application database and we would like to configure separate database for spring batch. To overcome this situation we will configure the different datasource for spring batch using in-memory database, since we don't want to store batch job details permanently. Other thing is the configuration of  spring cloud task in case of multiple datasource and it must point to the same data source which is pointed by spring batch. In below sections, we will se how to configure application, batch and cloud task related data sources. Application Data Source Define the data source in application properties or yml con