Ibexa DXP 5 : Introduction d'OpenAPI pour les points d'extrémité de l'API REST
La connectivité est aujourd’hui une exigence fondamentale pour toute plateforme web moderne. Depuis ses débuts, Ibexa DXP propose un solide support pour l’accès à distance via des APIs HTTP. Mais il y a toujours place à l’amélioration — c’est pourquoi, avec la version 5, nous sommes ravis d’annoncer lacompatibilité avec OpenAPI.
OpenAPI est une norme permettant de décrire de manière uniforme les points d'accès REST disponibles. Il ne dicte pas comment les API devraient fonctionner, mais fournit plutôt une structure pour exposer les capacités disponibles et leur fonctionnement. Elle est utile pour générer du code et des interfaces utilisateur afin de faciliter la découverte par les développeurs.
Les API REST et GraphQL sont largement utilisées dans les projets.
En tant que plateforme de développement, l'Ibexa DXP doit en tenir compte, et il est important de noter que les points d'extrémité de l'API continueront à fonctionner comme auparavant. En tant que tel, il n'y aura pas de changement radical suite à l'introduction d'OpenAPI.
Vous pouvez être assuré que vous pouvez vous concentrer sur d'autres mises à jour si vous mettez à jour Ibexa DXP 4.6 LTS ou une version antérieure.
OpenAPI sera livré par défaut dans toutes les éditions d'Ibexa DXP. La sortie de la spécification/documentation par défaut sera disponible de trois façons :
- Sur votre (vos) installation(s) Ibexa DXP dans le chemin /api/ibexa/v2/doc
- Le schéma REST sera exporté sous forme de YAML pour être digéré par les outils.
- Notre référence API REST publique sera générée avec Redoc d'Ibexa Commerce.
En utilisant ces ressources, n'importe quel développeur ou application peut rapidement commencer à utiliser les API RESTful qu'Ibexa DXP offre. La spécification OpenAPI a été largement adoptée par l'industrie et est largement supportée par les outils de développement.
Grâce à la documentation, l'utilisation de requêtes REST personnalisées dans Ibexa Connect sera plus facile qu'auparavant. Mais le véritable potentiel réside dans l'automatisation. Étant donné que la norme décrit les capacités de la plateforme, les assistants de codage et les agents d'intelligence artificielle peuvent utiliser la spécification pour se familiariser avec la fonction.
Les API publiques puissantes sont un point de chute potentiel pour les pirates informatiques. Mais comme le schéma OpenAPI n'est qu'une référence à toutes les capacités, vous serez toujours protégé par les garde-fous de sécurité fournis par Ibexa DXP.
Avec un utilisateur API bien limité pour les requêtes générales et des permissions bien conçues pour les niveaux d'utilisateurs individuels, cela ne peut pas être utilisé comme vecteur d'attaque.