API Management Design Patterns for Digital Transformation

DZone 's Guide to

API Management Design Patterns for Digital Transformation

This article discusses the workings of three patterns for API management in greenfield microservices architecture for the enterprise.

· Integration Zone ·
Free Resource

Digital Transformation (DT) has become a buzzword in the tech industry these days. The meaning of DT can be interpreted in different ways at different places, but simply, it is the digitization of your business assets with the increased use of technology. If that definition is not simple enough, you can think of an example like moving your physical file/folder-based documents to computers and making them accessible instantly rather than browsing through thousands of files stacked in your office. In a large enterprise, this will go to the level where every asset in the business (from people to vehicles to security cameras) becomes a digital asset and instantly reachable as well as authorized.

Once you have your assets in digitized format, it is quintessential to expose that digital information to various systems (internal as well as external) through properly managed interfaces. Application Programming Interfaces (API) are the de facto standard for exposing your business functionalities to internal and external consumers. It is evident that your DT story will not be completed without having a proper API management platform in place.

Microservices Architecture (MSA) has evolved from being a theory on Martin Fowler’s website to a go-to technology to implement REST services for your organization when achieving DT. Most of the developers in the enterprise are moving towards MSA when writing business logic to implement back-end core services. But in reality, there are so many other systems which are coming as Commercial Off-the-Shelf (COTS) offerings which do not fit into the microservices landscape natively.

With these basic requirements and unavoidable circumstances within your organization’s IT ecosystem, how are you going to implement an efficient API management strategy? This will be the burning problem in most enterprises, and I will be touching up on possible solution patterns to address this problem.

API Management for Greenfield MSA

If your organization is just a startup and you don’t want to use high-cost COTS software in your IT ecosystem, you can start things off with full MSA. This kind of organization is called a greenfield ecosystem, where you have complete control of what needs to be developed and how those services are going to be developed. Once you have your back-end core services written as microservices, you can decide on exposing them as APIs through a proper API management platform.

Pattern 1 - Central API Manager to Manage All Your Microservices

As depicted in the figure below, this design pattern can be applied to a greenfield MSA where microservices discovery, authentication, and management can be delegated to the central API management layer. There is a message broker for asynchronous inter-service communication.

MSA central API gateway.png

Figure 1: Central API management in a green field MSA.

Pattern 2 - Service Mesh Pattern With Side Car (Micro-gateway)

This pattern applies to a greenfield MSA where all the back-end systems are implemented as microservices, but this pattern can also be applied to scenarios where you have both microservices as well as monolithic (COTS) applications with slight modifications.

MSA micro API gateway (Service mesh architecture).png

Figure 2: API management with service mesh and sidecar (micro gateway).

API Management for Practical Enterprise Architecture

As mentioned at the beginning of this post, most of the real world enterprises use COTS software as well as various cloud services to fulfill their day-to-day business requirements. In such an environment, if you are implementing MSA, you need to accept that existing systems are there to stay for a long time and MSA should be able to live along with those systems.

Pattern 3 - API Management for Modern Hybrid Ecosystems

This design pattern is mostly suited for enterprises which have COTS systems as well as MSA. This pattern is easy to implement and has been identified as the common pattern to apply to a hybrid microservices ecosystem.

Modern enterprise central API gateway with ESB.png

Figure 3: API management for modern enterprise.

The same pattern can be applied to any enterprise which does not have any microservices, but only traditional monolithic applications as back-end services. In such scenarios, microservices will be replaced by monolithic web applications.

api management, digital transformation, enterprise, integration, microservices

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}