![\"Logo](\"https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2021\/03\/logo-gravitee.png\"){kind=logo}
<\/a><\/figure><\/div>\n\n\n\nGravitee est une solution d\u2019API Management<\/strong>, aussi appel\u00e9e API Plateform, ou API Gateway (mais c\u2019est r\u00e9ducteur).<\/p>\n\n\n\n Cet outil open-source d\u00e9velopp\u00e9 par une soci\u00e9t\u00e9 lilloise, est un concurrent d\u2019outils du m\u00eame type comme : Kong, Apigee, WSO2, Tyk.<\/p>\n\n\n\n Il est compos\u00e9 de plusieurs briques ind\u00e9pendantes qui couvrent la plupart des besoins de ce type d\u2019architecture.<\/p>\n\n\n\n Le principal int\u00e9r\u00eat est l’utilisation de l’API Gateway qui devient le point unique d’acc\u00e8s aux API et va donc centraliser tous les appels. Il peut \u00eatre coupler \u00e0 un Access Management qui sera responsable de la gestion de l’authentification et des autorisations.<\/p>\n\n\n\n\n\n\n\n Ce composant est divis\u00e9 en 3 parties :<\/p>\n\n\n\n Gateway<\/strong><\/p>\n\n\n\n C’est la partie la plus importante, celle qui est responsable des requ\u00eates HTTP entrantes et sortantes. Plut\u00f4t que de laisser la gateway g\u00e9rer l’authentification, il est possible de mettre en place le composant d’Access Management, la gateway se chargera lors d’un appel de valider le token aupr\u00e8s de ce composant.<\/p>\n\n\n\n Management<\/strong><\/p>\n\n\n\n C’est via l’API management et son interface que l’on va pouvoir ajouter, param\u00e9trer et publier nos API. Portail API<\/strong><\/p>\n\n\n\n Les API publi\u00e9es sont disponibles via un \u00ab\u00a0portail des API\u00a0\u00bb, qui sera le catalogue des API disponibles (et de leur documentation). Ce composant peut-\u00eatre utilis\u00e9 ind\u00e9pendamment de l’API Gateway, et dans un cadre compl\u00e8tement diff\u00e9rent. Coupler l’API Gateway \u00e0 ce composant permet de proposer une authentification OAuth2. Pour fonctionner, Gravitee n\u00e9cessite Elasticsearch et une BDD (MongoDB, PostgreSQL, MariaDB etc). Gravitee tourne avec Java, il faut donc pr\u00e9voir de monitorer les JVM (Centreon, Zabbix ou autre). La version entreprise propose un module d’alert engine packag\u00e9 avec la solution.<\/p>\n\n\n\n Au sein de l’API Management, il est \u00e9galement possible d’appliquer des r\u00e8gles d’IP filtering (selon des routes sp\u00e9cifiques par exemple), de coder des morceaux de Groovy pour des besoins sp\u00e9cifiques, voire de coder ses propres plugins en Java. Pour les plus curieux vous pouvez installer la stack Docker via le docker-compose disponible sur la documentation officielle<\/a> et parcourir l’ensemble des fonctionnalit\u00e9s :)<\/p>\n<\/a><\/figure><\/div>\n\n\n\nAPI Management<\/h2>\n\n\n\n
La gateway encaisse donc tous les appels aux API et elle peut y apporter des transformations (rate limiting, authorization via JWT, cache, SOAP to REST, logging etc.).
C’est elle qui passe ensuite la requ\u00eate aux API Backend (API de stock, produits, etc.), et qui renvoie la donn\u00e9e au client.<\/p>\n\n\n\n
Une API pourra donc disposer d’une documentation (au format swagger ou autre), d’une URL de health-check pour v\u00e9rifier la bonne sant\u00e9 de celle-ci, et de \u00ab\u00a0plans\u00a0\u00bb destin\u00e9s \u00e0 accorder l’acc\u00e8s ou non.<\/p>\n\n\n\n
Ce catalogue est customisable pour coller au mieux \u00e0 l’identit\u00e9 graphique souhait\u00e9e.<\/p>\n\n\n\nAccess Management<\/h2>\n\n\n\n
Son but est de g\u00e9rer les authentifications et autorisations utilisateurs.
Il se base sur les protocoles OAuth2 et OpenID Connect.<\/p>\n\n\n\n
Si on se r\u00e9f\u00e8re au sch\u00e9ma pr\u00e9c\u00e9dent, le client va r\u00e9cup\u00e9rer son token en s’identifiant aupr\u00e8s de l’AM, qui lui renverra un token.
Il pourra ensuite interroger l’API Gateway en passant ce token, qui v\u00e9rifiera la validit\u00e9 du token \u00e0 l’aide de l’AM : le token est-il \u00e0 jour ? Cet utilisateur a-t-il souscrit au plan de l’API demand\u00e9 ? A-t-il d\u00e9pass\u00e9 sa limite de requ\u00eate ? etc.<\/p>\n\n\n\nArchitecture<\/h2>\n\n\n\n
Exemple d’architecture pour la mise en place la solution Gravitee avec l’API Management et l’Access Management, pour un volume de 100 requ\u00eates \/ seconde :<\/p>\n\n\n\n
Il est \u00e9galement gourmand en index Elasticsearch et n\u00e9cessite de param\u00e9trer l’ILM<\/a>, via l’interface Kibana par exemple, pour ne pas saturer l’espace disque.<\/p>\n\n\n\nMais aussi…<\/h2>\n\n\n\n
On peut renseigner plusieurs endpoint d’API Backend, avec une gestion de failover.
Les statistiques et contenu d’appels HTTP sont consultables dans des dashboards.<\/p>\n\n\n\n