What is API Management Systems

Why are they needed and what functions they perform.

Hello everyone! My name is Anton and I am an engineer on the team responsible for the development of centralized IT services used by the product teams at X5 Retail Group.

In this article I will talk about systems of the API Management class and in particular about APIM Gravitee ( https://www.gravitee.io ), what this class of systems is, how they are used to meet the needs of development teams. The article does not dive into the technical aspects, but it can be useful for architects and managers who are thinking about trying to use this class of systems, but do not know if they are suitable for their tasks, as well as for developers who may discover new tools for convenient work with API.

What is API Management Systems

Definition

API Management - - (API), , , , . 

, API Management - , , , API .

"API Management" , API , , . , , , API.

?

, API . ? - . "". API, : , .. API, , , . API : , , , / IP. , JSON , DevOps rate limit, DoS , : Service Discovery, Load Balancing, Blue/Green Canary deploy. 

API Management (. . 1):

1. Management Core: , , , , API Gateways API, CORS, Failover, Healthcheck, API .

   
   
   
   
   

2. Web/Development Portal: UI, , API, healthcheck , , API.

   
   
   
   
   

3. API Gateways: , , , healthcheck Backend API.

   
   
   
   
   

4. Backend API: - .

   
   
   
   
   

5. Databases: API Management, API, API Gateways, backend, healthcheck, API Management.

   
   
   
   
   

API Management

:

• : .

  
  
  
  
  

• :  , , Keycloak.

  
  
  
  
  

• : API.

  
  
  
  
  

• API: / .

  
  
  
  
  

• : / API.

  
  
  
  
  

:

• Latency: / .

  
  
  
  
  

• TCO: , , nginx . 

  
  
  
  
  

API Gateways

API Gateways ( ), (. . 2). API Gateways /, . API Gateways , / . API Gateways , . API Gateways, , (L7) OSI.

 API Gateways

API Gateways:

• Local API Gateways  .

  
  
  
  
  

• DMZ API Gateways  .

  
  
  
  
  

, , . . - .

Gravitee

X5 Retail Group APIM Gravitee (https://www.gravitee.io). – API DMZ.

:

• 23

  
  
  
  
  

• 69 API Gateways

  
  
  
  
  

• 400

  
  
  
  
  

• 350 RPS

  
  
  
  
  

• 30 000 000+

  
  
  
  
  

, APIM Gravitee.

1. Identity provider: :

   
   
   
   
   

1. MongoDB ( , );

   
   
   
   
   

2. In-memory ( admin);

   
   
   
   
   

3. LDAP / Active Directory;

   
   
   
   
   

4. OpenID Connect IdP (Azure AD, Google);

   
   
   
   
   

2. Fetchers: API :

   
   
   
   
   

2. File (Swagger, OpenAPI);

   
   
   
   
   

3. HTTP;

   
   
   
   
   

4. GIT;

   
   
   
   
   

3. Policies: , . . -, - . :

   
   
   
   
   

3. API Key - API-;

   
   
   
   
   

4. Rate-limiting - backend;

   
   
   
   
   

5. Transform Headers/Transform Query Parameters - ;

   
   
   
   
   

6. etc.

   
   
   
   
   

Gravitee Gateway 30 . . , "", . 

4. Reporters: . :

   
   
   
   
   

4. Reporter file;

   
   
   
   
   

5. Elasticsearch;

   
   
   
   
   

6. Accesslog;

   
   
   
   
   

, :

4. / — , , , api-;

   
   
   
   
   

5. — , , , - ..;

   
   
   
   
   

6. — , , ;

   
   
   
   
   

5. Repositories: - API, , , . :

   
   
   
   
   

5. MongoDB ( );

   
   
   
   
   

6. Redis;

   
   
   
   
   

7. Elasticsearch;

   
   
   
   
   

8. PostgreSQL ( JDBC );

   
   
   
   
   

6. Resources: , :

   
   
   
   
   

6. OAuth2 ( OAuth2 );

   
   
   
   
   

7. Cache ( );

   
   
   
   
   

8. LDAP ( LDAP );

   
   
   
   
   

7. Services: , :

   
   
   
   
   

7. Sync ( );

   
   
   
   
   

8. local-registry ( API json . , API - rest API ( json API, .));

   
   
   
   
   

9. health-check ( );

   
   
   
   
   

10. monitor ( , os / process / jvm, );

    
    
    
    
    

8. Notifiers: . , , Slack.

   
   
   
   
   

8. Email;

   
   
   
   
   

9. Alerts: , Notifier.

   
   
   
   
   

9. Vertx;

   
   
   
   
   

: https://github.com/gravitee-io, Java, .

API

API :

1. API

   
   
   
   
   

2. 
   
   
   
   

3. API

   
   
   
   
   

API

API , API

, :

1. !

   
   
   
   
   

2. swagger .

   
   
   
   
   

3. Git/URL
   
   
   
   .

   
   
   
   
   

, "->"

API 5

API, , , API .

:

Simple mode backend api, : https://backend-server/backend-api/

Advanced mode   backend api, tenant sharding tags.

tenant - Elasticsearch .

sharding tags - , API Gateways

Plan

Plan - , , Gateway.

Name -  

Security type -  : Keyless(public), API Key, JWT, OAuth2

Description -

Rate limit - - /

Quota -  - ///

Path authorization -

API.

API

swagger.json

API.

" API ", " API"

CREATE API .

 

API . API , - "keyless". , .

:

1. Tags (. . 3)

   
   
   
   
   

2. (. . 4)

3. Rate Quota (. . 5)

4. , (. . 6)

, , Management API, . , , . , , ,  APIM Gravitee  . , , .