API Management

Understanding API Management


Before API Oriented Architecture


One single deliverable : the application. It contains the presentation, the business logic and the data-access

Application Server
Application Server
Application
appli-v2.0
Application...
Application User
Application User
Browser
html/js
Browser...
HTTP Traffic
HTTP Traffic
Server
Server
View
View
Controller
Controller
Legend
Legend
Model
Model
Viewer does not support full SVG 1.1

Before API Oriented Architecture (2)

API Oriented Architecture


The API Orientation has a deep impact on the architecture,

Static web Server
Static web Server
Front-end
appli-2 v3.0
Front-end...
Appli-2 User
Appli-2 User
Browser
js/xhr
Browser...
Application Server
Application Server
Back-end
API v1.0
Back-end...
API
API
HTTP Traffic
HTTP Traffic
Server
Server
Legend
Legend
Viewer does not support full SVG 1.1

API Oriented Architecture (2)

API Management : Common issues

Common problems encountered : different speed for development

Front
Front
Back
Back
1
1
1
1
2
2
2
2
3
3
legend
legend
Front feature
Front feature
Back-end feature
Back-end feature
1
1
realization order
realization order
communication ok
communication ok
communication ko
communication ko
Viewer does not support full SVG 1.1

API Management problems : solutions

The solution : working with contracts, and enforce them

Contracts
Contracts
Front
Front
Back
Back
1
1
2
2
3
3
4
4
5
5
6
6
6
6
7%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%26lt%3Bfont%26gt%3B%26lt%3Bb%26gt%3B6%26lt%3B%2Fb%26gt%3B%26lt%3B%2Ffont%26gt%3B%22%20style%3D%22ellipse%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3Baspect%3Dfixed%3BfontSize%3D11%3BstrokeColor%3D%23666666%3BfillColor%3D%23f5f5f5%3BfontColor%3D%23333333%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22160%22%20y%3D%22250%22%20width%3D%2220%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
7%3...
7
7
8
8
legend
legend
Front feature
Front feature
Back-end feature
Back-end feature
1
1
realization order
realization order
communication ok
communication ok
communication ko
communication ko
Viewer does not support full SVG 1.1

API Lifecycle problem

Front-end - 2 
appli-2 v3.0
Front-end - 2...
Back-end
api-2 v1.0
Back-end...
Back-end
api-1 v1.0
Back-end...
Front-end - 1
appli-1 v5.0
Front-end - 1...
Front-end
appli-2 v3.1
Front-end...
Front-end
appli-2 v3.2
Front-end...
Back-end
api-2 v1.1
Back-end...
1
1
2
2
3
3
Legend
Legend
dependency
dependency
Front-end
Front-end
API
API
Viewer does not support full SVG 1.1

API Management : Tools

To keep urbanism up to date, we need to integrate an API Manager

Apache Server
Apache Server
Front-end
Appli v3.0
Front-end...
Application User
Application User
Browser
js/xhr
Browser...
Application Server
Application Server
Back-end
API v3.0
Back-end...
API
API
HTTP Traffic
HTTP Traffic
Server
Server
Legend
Legend
API Gateway
API Gateway
APIManager
APIManager
Viewer does not support full SVG 1.1

Advantages of API Manager


API Manager : tools